# pixcat
[](
http://pepy.tech/project/pixcat)
[](
https://pypi.org/project/pixcat)
[](
https://pypi.python.org/pypi/pixcat)
**WORK IN PROGRESS**
Display images on a [kitty](https://sw.kovidgoyal.net/kitty/) terminal
with optional custom/thumbnail/fit-to-screen resizing.
Developed with the goal of being a more powerful alternative to `kitty icat`,
while also providing an usable Python 3.6+ API.
## Usage
Basic CLI examples:
```sh
pixcat file.jpg
pixcat fit-screen --enlarge /tmp/abc.jpg
pixcat thumbnail --size 128 --align left 'https://picsum.photos/480?random'
pixcat resize --min-width 1920 --min-height 1080 \
--max-width 1920 --max-height 1080 \
~/images/wallpapers 1.jpg 2.png
```
The commands and options have short forms too.
See `pixcat --help` for more information.
Same examples using the Python package (no documentation yet):
```python3
from pixcat import Image
Image("file.jpg").show()
Image("/tmp/abc.jpg").fit_screen(enlarge=True).show()
Image("https://picsum.photos/480?random").thumbnail(128).show(align="left")
for i in Image.factory("~/images/wallpapers", "1.jpg", "2.png"):
i.resize(1920, 1080, 1920, 1080).show()
```
## Installation
Requires Python 3.6+, tested on GNU/Linux only.
```sh
pip3 install --upgrade pixcat
```
Raw data
{
"_id": null,
"home_page": "https://github.com/mirukan/pixcat",
"name": "pixcat",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "kitty api cli terminal print display resize scale image picture graphic icat",
"author": "miruka",
"author_email": "miruka@disroot.org",
"download_url": "https://files.pythonhosted.org/packages/61/ed/4212f7edd385863b9ecaf3b5fb82aebbb0ee638beeaf16dbf718a636db39/pixcat-0.1.4.tar.gz",
"platform": "",
"description": "# pixcat\n\n[](\n http://pepy.tech/project/pixcat)\n[](\n https://pypi.org/project/pixcat)\n[](\n https://pypi.python.org/pypi/pixcat)\n\n**WORK IN PROGRESS**\n\nDisplay images on a [kitty](https://sw.kovidgoyal.net/kitty/) terminal\nwith optional custom/thumbnail/fit-to-screen resizing. \nDeveloped with the goal of being a more powerful alternative to `kitty icat`,\nwhile also providing an usable Python 3.6+ API.\n\n## Usage\n\nBasic CLI examples:\n\n```sh\npixcat file.jpg\n\npixcat fit-screen --enlarge /tmp/abc.jpg\n\npixcat thumbnail --size 128 --align left 'https://picsum.photos/480?random'\n\npixcat resize --min-width 1920 --min-height 1080 \\\n --max-width 1920 --max-height 1080 \\\n ~/images/wallpapers 1.jpg 2.png\n```\n\nThe commands and options have short forms too. \nSee `pixcat --help` for more information.\n\nSame examples using the Python package (no documentation yet):\n\n```python3\nfrom pixcat import Image\n\nImage(\"file.jpg\").show()\n\nImage(\"/tmp/abc.jpg\").fit_screen(enlarge=True).show()\n\nImage(\"https://picsum.photos/480?random\").thumbnail(128).show(align=\"left\")\n\nfor i in Image.factory(\"~/images/wallpapers\", \"1.jpg\", \"2.png\"):\n i.resize(1920, 1080, 1920, 1080).show()\n```\n\n## Installation\n\nRequires Python 3.6+, tested on GNU/Linux only.\n\n```sh\npip3 install --upgrade pixcat\n```\n\n\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Display images on a kitty terminal with optional resizing.",
"version": "0.1.4",
"split_keywords": [
"kitty",
"api",
"cli",
"terminal",
"print",
"display",
"resize",
"scale",
"image",
"picture",
"graphic",
"icat"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "1ae6be37fdfbabeb931e94a06c63944d",
"sha256": "21308ff5c5fd216a8fe9bf8dd7f554d0a5ec08f1fd4a273291352ca3b371b91e"
},
"downloads": -1,
"filename": "pixcat-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ae6be37fdfbabeb931e94a06c63944d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 11645,
"upload_time": "2018-10-02T20:03:11",
"upload_time_iso_8601": "2018-10-02T20:03:11.468366Z",
"url": "https://files.pythonhosted.org/packages/5f/a9/9dc8ca0d01a09ca7d8e3ef1fe9f2a918f5698c3a8b947fb106d6177d5b38/pixcat-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "5b263b888545c2eee72ce71b3bf383d4",
"sha256": "657c8fe04513caecccd6086b347aa4b85db6b4c0f761b162cb9cd789abe7abb6"
},
"downloads": -1,
"filename": "pixcat-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "5b263b888545c2eee72ce71b3bf383d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 9795,
"upload_time": "2018-10-02T20:03:13",
"upload_time_iso_8601": "2018-10-02T20:03:13.442865Z",
"url": "https://files.pythonhosted.org/packages/61/ed/4212f7edd385863b9ecaf3b5fb82aebbb0ee638beeaf16dbf718a636db39/pixcat-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-10-02 20:03:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mirukan",
"github_project": "pixcat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pixcat"
}
JSON
