Simple Python package to display an image in the terminal by converting it into text. For the desired behavior to be achieved, the terminal must support colors, unicode characters and there should be no spacing between lines (0 line-spacing).
Installation
pip install image-in-terminal
How to use
You can use the package either from the terminal or from a script.
From terminal:
imageinterminal "myImage.jpg"
iit "https://images/exampleImage.jpg" "myOtherImage.png" -w 128
iit "myImagesOnWhiteBackgrounds" --width 256 -wt 0.97
iit myImage2.png --no-fit --no-center
From script:
from imageinterminal import display_image
display_image("myImage.jpg")
# Do not display
# img_str = display_image("myImage.jpg", display=False)
Help menu
imageinterminal -h
Usage:
iit image_uris [options]
Image In Terminal
v1.3
by Odell
2023-2025
Positional Arguments:
image_uris File path(s) or HTTP/HTTPS link(s) of the image(s) to be displayed. A directory can also be passed in which case all supported images in the directory will be
displayed.
Options:
-w, --width N Destination width of the image(s).
-wt, --whiteness-threshold N.
(float [0 - 1]). Pixels with a whiteness higher than this value will be inverted.
-dt, --darkness-threshold N.
(float [0 - 1]). Pixels with a whiteness lower than this value will be inverted.
-r, --recursive If a directory is passed as image_uri the image search will be recursively performed within the directory passed and all its subdirectories.
-pp, --procedural-printing
The image(s) pixels will be printed one by one procedurally instead of printing/displaying the entire image at once. Useful when printing/displaying high
resolution images.
-nc, --no-center Do not center image(s).
-nf, --no-fit Do not automatically fit image(s) width to terminal width when -w/--width is not specified.
-ll, --log-level N Log level. Default: 20. CRITICAL = 50, FATAL = CRITICAL, ERROR = 40, WARNING = 30, INFO = 20, DEBUG = 10, NOTSET = 0
Miscellaneous:
-h, --help Show this help message and exit.
-v, --version Show version number and exit.
Simple Python package to display a single or multiple images in the terminal by converting it into text. For the desired behavior to be achieved, the terminal must support colors,
unicode characters and there should be no spacing between lines (0 line-spacing).
Donate
If you find my work useful and want to encourage further development, you can do so by donating
USDT (BEP20 - BSC)
0x88046e6d0f2bf8629cd7fbd754e4e275083fc993
USDT (SOL - Solana)
BL3QX5GtfXp8qha8PMLVwyud7gxB1aPE4Vsqotwscxsv
USDT (TRC20 - Tron)
TMpXigKBghRQmgYD53KyuxS38FH516ermu
BTC
1E9kw3FuaahfeproboNL7uvyBdjP9wY6CR
BTC (BEP20)
0x88046e6d0f2bf8629cd7fbd754e4e275083fc993
TON
UQCyCnWVYOmv97idVFZ4tIewToZacRhYVwfGNU658fN5w3Kl
Speed Lightning Address username
bytechanger@speed.app
Screenshots
JPG 1440x1800
JPG 256x256
PNG 256x256
Procedural Printing
Metadata
Release files for image-in-terminal 1.32
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| image_in_terminal-1.32.tar.gz | 7.9 kB | Without provenance | Details for image_in_terminal-1.32.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| image_in_terminal-1.32-py3-none-any.whl | Python 3 | none | any | Details for image_in_terminal-1.32-py3-none-any.whl |
Total release size: 18.0 kB
Release files / image_in_terminal-1.32.tar.gz
| Download URL | image_in_terminal-1.32.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a0ab2758e182753c3f8d0ff69997a4f323313fed463f3c5fb4ab125a959af9f
|
|
BLAKE2b-256 checksum How to use checksums |
00c1b139182415e4f76906576f3f32e4c99c85c77749898053cd9e1827393594
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.5
|
Release files / image_in_terminal-1.32-py3-none-any.whl
| Download URL | image_in_terminal-1.32-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44e764611ff6a9f416649c5513eaf50d992dd45a63a990e9d98782db65047593
|
|
BLAKE2b-256 checksum How to use checksums |
9bbf44bf9727b463c4996975fd87e63056a92fb13a154440d3b7894c999a4395
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.5
|
Security for image-in-terminal 1.32
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.