1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
Installation
============
Requirements
------------
* Operating System: Unix / Linux / MacOS X / Windows (limited support, see the :doc:`/faqs`)
* `Python <https://www.python.org/>`_ >= 3.7
* A terminal emulator with **any** of the following:
* support for the `Kitty graphics protocol <https://sw.kovidgoyal.net/kitty/graphics-protocol/>`_.
* support for the `iTerm2 inline image protocol <https://iterm2.com/documentation-images.html>`_.
* Unicode support and direct-color (truecolor) or indexed-color (256-color) support.
**Plans to support a wider variety of terminal emulators are in motion** (see :doc:`/planned`).
Steps
-----
The latest **stable** version can be installed from `PyPI <https://pypi.org/project/term-image>`_ with:
.. code-block:: shell
pip install term-image
The **development** version can be installed with:
.. code-block:: shell
pip install git+https://github.com/AnonymouX47/term-image.git
Supported Terminal Emulators
----------------------------
Some terminals emulators that have been tested to meet the requirements for at least one render style include:
- Alacritty
- iTerm2
- Kitty
- Konsole
- MinTTY (on Windows)
- Terminal (on Mac OS)
- Terminology
- Termux (on Android)
- WezTerm
- Windows Terminal
- XTerm
- **libvte**-based terminal emulators such as:
- Gnome Terminal
- Terminator
- Tilix
.. note::
If you've tested ``term-image`` on any other terminal emulator that meets all
requirements, please mention the name in a new thread under `this discussion
<https://github.com/AnonymouX47/term-image/discussions/4>`_.
Also, if you're having an issue with terminal support, you may report or check
information about it in the discussion linked above.
.. note::
Some terminal emulators support 24-bit color escape sequences but have a
256-color pallete. This will limit color reproduction.
|
