Skip to content

Latest commit

 

History

History
127 lines (82 loc) · 2.86 KB

README.md

File metadata and controls

127 lines (82 loc) · 2.86 KB
Raw

Img2sh

autopep8 pylint pytest

Img2sh is a tool to show images directly on terminal. For color images 256 xterm color support is required. This script basically resize the image with antialliasing and quantized its colors to xterm color pallette.

Demo

Testing the package is super easy. Install and run.

pip install img2sh --user
img2sh demo.jpeg

Result:

Demo with interactive mode

img2sh demo.jpeg -w 80 -i

q: quit z: zoom+ x: zoom- c: reset 
arrow keys for navigation 
cmd: q

For detailed usage arguments:

$ python img2sh/cli.py --help

usage: cli.py [-h] [-w WIDTH] [-i] Image

Show images directly on terminal.

positional arguments:
  Image                 the directory of the image which will be opened

optional arguments:
  -h, --help            show this help message and exit
  -w WIDTH, --width WIDTH
                        image width on the terminal
  -i, --interactive     open image in interactive mode

Installing

It can be easily install using pip.

pip install img2sh --user

Installing from source:

git clone https://github.com/mozanunal/img2sh
cd img2sh
pip install -r requirements.txt
python setup.py install

Development

Setup development environment

Conda is using for environment management.

conda create -n img2sh python=3.8

Following command should be executed to create interactive shell in this conda environment.

conda activate img2sh

Development

In this repo issue based development is active. For any problems or new enhancements please open a issue.

Autopep8 is used for formatting.

autopep8 -r -i img2sh test

Pylint is used for linting.

pylint img2sh

Deployment

The following 2 commands are required to deploy over pypi.

python setup.py sdist bdist_wheel
twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

Licence

MIT

Acknowledges

This package is developed using:

Contributors