Installation
Requirements
Operating System: Unix / Linux / MacOS X / Windows (partial, see the FAQs)
A terminal emulator with full Unicode support and ANSI 24-bit color support
Plans are in place to [partially] support terminals not meeting this requirements (see Planned Features).
Steps
The package can be installed from PyPI using pip:
pip install term-image
OR
Clone this repository using any method, then navigate into the project directory in a terminal and run:
pip install .
Supported Terminal Emulators
Some terminals emulators that have been tested to meet all major requirements are:
libvte-based terminals such as:
Gnome Terminal
Terminator
Tilix
Alacritty
Kitty
Windows Terminal
Termux (on Android)
xterm, uxterm (256 colors)
Warning
With some of these terminals, there’s an issue where the TUI isn’t cleared off the terminal screen after exiting.
Mannually running clear should clear the terminal screen.
Note
If you’ve tested term-img on any other terminal emulator that meets all requirements, please mention the name in a new thread under this discussion.
Also, if you’re having an issue with terminal support, also report or view information about it in the discussion linked above.
See here for information about terminal colors and a list of potentially supported terminal emulators.
Warning
Some terminal emulators support 24-bit colors but have a 256-color pallete. This will limit color reproduction