Metadata-Version: 2.4
Name: python_sixel_windows
Version: 0.2.1
Summary: Display images in the terminal
Project-URL: Homepage, https://github.com/jakekyee/python_sixel_windows
Project-URL: Bug Tracker, https://github.com/jakekyee/python_sixel_windows/issues
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: image,sixel,terminal
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Terminals
Requires-Python: >=3.0
Requires-Dist: pillow
Description-Content-Type: text/markdown

# 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
```
