| Name | python-sixel-windows JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | Display images in the terminal |
| upload_time | 2025-08-07 05:41:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.0 |
| license | None |
| keywords |
image
sixel
terminal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# python-sixel
Display images in the terminal using [Sixel](https://en.wikipedia.org/wiki/Sixel).
This is a fork of [PySixel](https://github.com/lubosz/python-sixel) to add windows compatibility.
Check [arewesixelyet.com](https://www.arewesixelyet.com/) for supported terminals.
## Installation
### PyPI release
```
pip install python_sixel_windows
```
```python
import sys
from sixel import converter
c = converter.SixelConverter("foo.png")
c.write(sys.stdout)
```
See examples directory for more examples.
## sixelconv
python-sixel provides a command line tool.
Display an image in the terminal
```
sixelconv [options] filename
```
Or by using a pipe
```
cat filename | sixelconv [options]
```
### Options
```
-h, --help show this help message and exit
-8, --8bit-mode Generate a sixel image for 8bit terminal or printer
-7, --7bit-mode Generate a sixel image for 7bit terminal or printer
-r, --relative-position Treat specified position as relative one
-a, --absolute-position Treat specified position as absolute one
-x LEFT, --left=LEFT Left position in cell size, or pixel size with unit 'px'
-y TOP, --top=TOP Top position in cell size, or pixel size with unit 'px'
-w WIDTH, --width=WIDTH Width in cell size, or pixel size with unit 'px'
-e HEIGHT, --height=HEIGHT Height in cell size, or pixel size with unit 'px'
-t ALPHATHRESHOLD, --alpha-threshold=ALPHATHRESHOLD Alpha threshold for PNG-to-SIXEL image conversion
-c, --chromakey Enable auto chroma key processing
-n NCOLOR, --ncolor=NCOLOR Specify number of colors
-b, --body-only Output sixel without header and DCS envelope
-f, --fast The speed priority mode (default)
-s, --size The size priority mode
```
### Examples
View an image file
```
sixelconv test.png
```
Generate sixel file from an image file
```
sixelconv < test.png > test.six
```
View generated sixel file
```
cat test.six
```
Raw data
{
"_id": null,
"home_page": null,
"name": "python-sixel-windows",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "image, sixel, terminal",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/23/c8/2b0c7d9ff671ce4b71f6ec741c454fd122b1223ea5a5ddb567fb8105918f/python_sixel_windows-0.2.1.tar.gz",
"platform": null,
"description": "# python-sixel\n\nDisplay images in the terminal using [Sixel](https://en.wikipedia.org/wiki/Sixel).\n\nThis is a fork of [PySixel](https://github.com/lubosz/python-sixel) to add windows compatibility.\n\nCheck [arewesixelyet.com](https://www.arewesixelyet.com/) for supported terminals.\n\n## Installation\n\n### PyPI release\n```\npip install python_sixel_windows\n```\n\n\n\n```python\nimport sys\nfrom sixel import converter\n\nc = converter.SixelConverter(\"foo.png\")\nc.write(sys.stdout)\n```\n\nSee examples directory for more examples.\n\n## sixelconv\n\npython-sixel provides a command line tool.\n\nDisplay an image in the terminal\n```\nsixelconv [options] filename\n```\n\nOr by using a pipe\n```\ncat filename | sixelconv [options]\n```\n\n### Options\n\n```\n-h, --help show this help message and exit\n-8, --8bit-mode Generate a sixel image for 8bit terminal or printer\n-7, --7bit-mode Generate a sixel image for 7bit terminal or printer\n-r, --relative-position Treat specified position as relative one\n-a, --absolute-position Treat specified position as absolute one\n-x LEFT, --left=LEFT Left position in cell size, or pixel size with unit 'px'\n-y TOP, --top=TOP Top position in cell size, or pixel size with unit 'px'\n-w WIDTH, --width=WIDTH Width in cell size, or pixel size with unit 'px'\n-e HEIGHT, --height=HEIGHT Height in cell size, or pixel size with unit 'px'\n-t ALPHATHRESHOLD, --alpha-threshold=ALPHATHRESHOLD Alpha threshold for PNG-to-SIXEL image conversion\n-c, --chromakey Enable auto chroma key processing\n-n NCOLOR, --ncolor=NCOLOR Specify number of colors\n-b, --body-only Output sixel without header and DCS envelope\n-f, --fast The speed priority mode (default)\n-s, --size The size priority mode\n```\n\n### Examples\n\nView an image file\n```\nsixelconv test.png\n```\n\nGenerate sixel file from an image file\n```\nsixelconv < test.png > test.six\n```\n\nView generated sixel file\n```\ncat test.six\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Display images in the terminal",
"version": "0.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/jakekyee/python_sixel_windows/issues",
"Homepage": "https://github.com/jakekyee/python_sixel_windows"
},
"split_keywords": [
"image",
" sixel",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a5664af88c1f1630eb192c55114bf363d8231f86faab0c76d786912a9a1fe80d",
"md5": "8d3a79b4ad44f4849d9b09997f5418a8",
"sha256": "58d1842104b9594a7293f13a97d7dee53de332699212295b4a2027cb7038b2f2"
},
"downloads": -1,
"filename": "python_sixel_windows-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d3a79b4ad44f4849d9b09997f5418a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 21094,
"upload_time": "2025-08-07T05:41:49",
"upload_time_iso_8601": "2025-08-07T05:41:49.918625Z",
"url": "https://files.pythonhosted.org/packages/a5/66/4af88c1f1630eb192c55114bf363d8231f86faab0c76d786912a9a1fe80d/python_sixel_windows-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "23c82b0c7d9ff671ce4b71f6ec741c454fd122b1223ea5a5ddb567fb8105918f",
"md5": "5694560a6f3af3a72b92c171310a353a",
"sha256": "ffb62a874b3ff4ebb1c26866bae1daafb31310161ed3e9e2248265935a4ad8ee"
},
"downloads": -1,
"filename": "python_sixel_windows-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "5694560a6f3af3a72b92c171310a353a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 19405,
"upload_time": "2025-08-07T05:41:51",
"upload_time_iso_8601": "2025-08-07T05:41:51.006855Z",
"url": "https://files.pythonhosted.org/packages/23/c8/2b0c7d9ff671ce4b71f6ec741c454fd122b1223ea5a5ddb567fb8105918f/python_sixel_windows-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 05:41:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jakekyee",
"github_project": "python_sixel_windows",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python-sixel-windows"
}
