{"id":17261343,"url":"https://github.com/saitoha/pysixel","last_synced_at":"2025-04-07T10:20:47.810Z","repository":{"id":54068828,"uuid":"6545356","full_name":"saitoha/PySixel","owner":"saitoha","description":"View full-pixel color graphics on SIXEL-supported terminals(xterm/mlterm/DECterm/Reflection/kermit/RLogin/tanasinn/yaft)","archived":false,"fork":false,"pushed_at":"2022-01-15T14:43:06.000Z","size":2628,"stargazers_count":180,"open_issues_count":4,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-31T09:06:46.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saitoha.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-11-05T14:14:37.000Z","updated_at":"2025-03-15T10:18:02.000Z","dependencies_parsed_at":"2022-08-13T06:21:10.674Z","dependency_job_id":null,"html_url":"https://github.com/saitoha/PySixel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saitoha%2FPySixel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saitoha%2FPySixel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saitoha%2FPySixel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saitoha%2FPySixel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saitoha","download_url":"https://codeload.github.com/saitoha/PySixel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247631833,"owners_count":20970069,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-15T07:50:50.135Z","updated_at":"2025-04-07T10:20:47.791Z","avatar_url":"https://github.com/saitoha.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"pysixel\n=======\n\nWhat is SIXEL?\n--------------\n\n.. image:: https://raw.githubusercontent.com/saitoha/PySIXEL/data/data/sixel_gnuplot.png\n   :width: 640\n\nSIXEL is one of image formats for terminal imaging introduced by DEC VT series.\nSIXEL image data scheme is represented as a terminal-friendly escape sequence.\nSo if you want to show a SIXEL image file, all you have to do is \"cat\" it to your terminal. \n\n*See also more faster high quality C implementation*\nlibsixel: https://github.com/saitoha/libsixel\n\n.. image:: https://raw.githubusercontent.com/saitoha/PySIXEL/data/data/sixel_hikari.png\n   :width: 640\n\nI heard SIXEL was supported by some old terminal applications, such as SAS, WordPerfect.\n\nNowadays netpbm and Gnuplot support this.\n\n.. image:: https://raw.githubusercontent.com/saitoha/PySIXEL/data/data/sixel_ls.png\n   :width: 640\n\n\nRequirements\n------------\n\nIf you want to view a SIXEL image, you have to get a terminal\nwhich support sixel graphics.\n\nNow SIXEL feature is supported by the following terminals.\n\n- RLogin (Japanese terminal emulator)\n\n  http://nanno.dip.jp/softlib/man/rlogin/\n\n- tanasinn (Works with firefox)\n\n  http://github.com/saitoha/tanasinn/\n\n- mlterm\n\n  Works on each of X, win32/cygwin, framebuffer version.\n  http://mlterm.sourceforge.net/\n\n- XTerm (compiled with --enable-sixel option)\n  You should launch xterm with \"-ti 340\" option.\n  the SIXEL palette is limited to a maximum of 16 colors.\n  http://invisible-island.net/xterm/\n\n- DECterm\n\n- Kermit\n\n- WRQ Reflection\n\n- ZSTEM\n\n\nInstall\n-------\n\nvia github ::\n\n    $ git clone https://github.com/saitoha/PySixel.git\n    $ cd pysixel \n    $ python setup.py install\n\nor via pip ::\n\n    $ pip install PySixel \n\n\nUsage\n-----\n\nPySixel provides a Command line tool::\n\n    $ sixelconv [options] filename\n\nor ::\n\n    $ cat filename | sixelconv [options]\n\n\n* Options::\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\nExample\n-------\n\nView an image file::\n\n    $ sixelconv test.png\n\nGenerate sixel file from an image file::\n\n    $ sixelconv \u003c test.png \u003e test.six\n\nView generated sixel file::\n\n    $ cat test.six\n\nShow sixel in xterm ::\n\n\t$ curl ftp://invisible-island.net/xterm/xterm-301.tgz | tar xz\n\t$ cd xterm-301\n\t$ ./configure --enable-wide-chars --enable-sixel-graphics --enable-256-color\n\t$ make\n\t# make install\n\t$ xterm -ti vt340 -e 'sixelconv -n16 ~/testdir/test.jpg'\n\n\nCode Example\n------------\n\n::\n\n    import sixel\n    writer = sixel.SixelWriter()\n    writer.draw('test.png') \n\nDependency\n----------\n\n - Pillow\n   https://github.com/python-imaging/Pillow\n\n - Python imageloader module \n   https://pypi.python.org/pypi/imageloader\n\nContributors\n-----------\n\n  - @cocuh (Python3 support)\n\nReference\n---------\n - Chris_F_Chiesa, 1990 : All About SIXELs\n   ftp://ftp.cs.utk.edu/pub/shuford/terminal/all_about_sixels.txt\n\n - Netpbm http://netpbm.sourceforge.net/\n\n   It includes ppmtosixel command\n   http://netpbm.sourceforge.net/doc/ppmtosixel.html\n\n - vt100.net http://vt100.net/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaitoha%2Fpysixel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaitoha%2Fpysixel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaitoha%2Fpysixel/lists"}