<div align="center">
<h1><b>Termslime</b></h1>
<p>Termslime displays images in your terminal with true colors.</p>
<p>
<img src="https://img.shields.io/pypi/v/termslime.svg">
<img src="https://img.shields.io/pypi/pyversions/termslime.svg">
<img src="https://img.shields.io/github/last-commit/garyzbm/termslime">
</p>
</div>
## Contents
+ [Requirements](#requirements)
+ [Installation](#installation)
+ [Usage](#usage)
+ [Credits](#credits)
## Requirements
+ A terminal emulator with true color support.
+ Python >= 3.7.
## Installation
Install with [pipx](https://pypa.github.io/pipx/) (recommended):
```shell
pipx install termslime
```
Or install with pip:
```shell
pip install termslime
```
## Usage
```
usage: tslime [-h] [-hl HEIGHTLIMIT] [-wl WIDTHLIMIT] [-bp BEGINPADDING] [-ep ENDPADDING] [-lp LEFTPADDING] path
Termslime displays images in your terminal with true colors. Project home page: https://github.com/garyzbm/termslime
positional arguments:
path path to an image file or a directory containing image files
options:
-h, --help show this help message and exit
-hl HEIGHTLIMIT, --heightLimit HEIGHTLIMIT
maximum number of lines of blocks to display the image in the terminal
-wl WIDTHLIMIT, --widthLimit WIDTHLIMIT
maximum number of blocks per line to display the image in the terminal
-bp BEGINPADDING, --beginPadding BEGINPADDING
number of empty lines before the image
-ep ENDPADDING, --endPadding ENDPADDING
number of empty lines after the image
-lp LEFTPADDING, --leftPadding LEFTPADDING
number of empty spaces at the beginning of each line of the image
```
## Credits
This project is greatly inspired by [this post](https://lucamug.medium.com/terminal-pixel-art-ad386d186dad).
The following projects are crucial to the development of this project:
+ [colorful](https://github.com/timofurrer/colorful)
+ [pillow](https://python-pillow.org)
+ [poetry](https://python-poetry.org)
---
*<p align="center">This project is published under [MIT](LICENSE).<br>A [Gary Zhang](https://github.com/garyzbm) project.<br>- :tada: -</p>*
Raw data
{
"_id": null,
"home_page": "https://github.com/garyzbm/termslime",
"name": "termslime",
"maintainer": "Gary Zhang",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "garyzhang2002@hotmail.com",
"keywords": "cli,image,terminal",
"author": "Gary Zhang",
"author_email": "garyzhang2002@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/cf/5c/443dd271efa5438ae731411a120421d40abfce1efc0942eed227fa22c0bf/termslime-0.2.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<h1><b>Termslime</b></h1>\n\n<p>Termslime displays images in your terminal with true colors.</p>\n\n<p>\n <img src=\"https://img.shields.io/pypi/v/termslime.svg\">\n <img src=\"https://img.shields.io/pypi/pyversions/termslime.svg\">\n <img src=\"https://img.shields.io/github/last-commit/garyzbm/termslime\">\n</p>\n\n</div>\n\n\n## Contents\n\n+ [Requirements](#requirements)\n+ [Installation](#installation)\n+ [Usage](#usage)\n+ [Credits](#credits)\n\n\n## Requirements\n\n+ A terminal emulator with true color support.\n+ Python >= 3.7.\n\n\n## Installation\n\nInstall with [pipx](https://pypa.github.io/pipx/) (recommended):\n```shell\npipx install termslime\n```\n\nOr install with pip:\n```shell\npip install termslime\n```\n\n\n## Usage\n\n```\nusage: tslime [-h] [-hl HEIGHTLIMIT] [-wl WIDTHLIMIT] [-bp BEGINPADDING] [-ep ENDPADDING] [-lp LEFTPADDING] path\n\nTermslime displays images in your terminal with true colors. Project home page: https://github.com/garyzbm/termslime\n\npositional arguments:\n path path to an image file or a directory containing image files\n\noptions:\n -h, --help show this help message and exit\n -hl HEIGHTLIMIT, --heightLimit HEIGHTLIMIT\n maximum number of lines of blocks to display the image in the terminal\n -wl WIDTHLIMIT, --widthLimit WIDTHLIMIT\n maximum number of blocks per line to display the image in the terminal\n -bp BEGINPADDING, --beginPadding BEGINPADDING\n number of empty lines before the image\n -ep ENDPADDING, --endPadding ENDPADDING\n number of empty lines after the image\n -lp LEFTPADDING, --leftPadding LEFTPADDING\n number of empty spaces at the beginning of each line of the image\n```\n\n\n## Credits\n\nThis project is greatly inspired by [this post](https://lucamug.medium.com/terminal-pixel-art-ad386d186dad).\n\nThe following projects are crucial to the development of this project:\n+ [colorful](https://github.com/timofurrer/colorful)\n+ [pillow](https://python-pillow.org)\n+ [poetry](https://python-poetry.org)\n\n\n---\n*<p align=\"center\">This project is published under [MIT](LICENSE).<br>A [Gary Zhang](https://github.com/garyzbm) project.<br>- :tada: -</p>*",
"bugtrack_url": null,
"license": "MIT",
"summary": "Termslime displays images in your terminal with true colors.",
"version": "0.2.1",
"project_urls": {
"Documentation": "https://github.com/garyzbm/termslime",
"Homepage": "https://github.com/garyzbm/termslime",
"Repository": "https://github.com/garyzbm/termslime"
},
"split_keywords": [
"cli",
"image",
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da9464278c7c21f504f5cbe95bdc5753720191748c0f2fdf2ae9a7d343fbac0b",
"md5": "7da88bfa356163a73188abb59b6dd7d2",
"sha256": "3416d873b5e51965ecc8b6694d953fc747c1fcefb860c49d31935b3d52f66f5a"
},
"downloads": -1,
"filename": "termslime-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7da88bfa356163a73188abb59b6dd7d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 4987,
"upload_time": "2023-06-19T08:02:05",
"upload_time_iso_8601": "2023-06-19T08:02:05.729547Z",
"url": "https://files.pythonhosted.org/packages/da/94/64278c7c21f504f5cbe95bdc5753720191748c0f2fdf2ae9a7d343fbac0b/termslime-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf5c443dd271efa5438ae731411a120421d40abfce1efc0942eed227fa22c0bf",
"md5": "4aaa2d4533a2034120b75947517a03d8",
"sha256": "5f61ccfc9a37cf7d92cbf735a9fc40f7550c9582c814d8f0501d7b202a2d1ccc"
},
"downloads": -1,
"filename": "termslime-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4aaa2d4533a2034120b75947517a03d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 4252,
"upload_time": "2023-06-19T08:02:07",
"upload_time_iso_8601": "2023-06-19T08:02:07.291690Z",
"url": "https://files.pythonhosted.org/packages/cf/5c/443dd271efa5438ae731411a120421d40abfce1efc0942eed227fa22c0bf/termslime-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 08:02:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "garyzbm",
"github_project": "termslime",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "termslime"
}
JSON
