<div align="center">

<h1><b>Term-Image</b></h1>

<p> <img src="https://raw.githubusercontent.com/AnonymouX47/term-image/92ff4b2d2e4731be9e1b2ac7378964ebed9f10f9/docs/source/resources/logo.png" height="200"> </p>

<p> <b>Display images in the terminal with Python</b> </p>

<p>

&#128214; <a href='https://term-image.readthedocs.io'>Docs</a>

&#9553;

System Message: WARNING/2 (<string>, line 16)

Definition list ends without a blank line; unexpected unindent.

&#127979; <a href='https://term-image.readthedocs.io/en/stable/start/tutorial.html'>Tutorial</a>

</p>

<p>

<a href='https://pypi.org/project/term-image/'>

<img src='https://img.shields.io/pypi/v/term-image.svg'>

System Message: WARNING/2 (<string>, line 22)

Definition list ends without a blank line; unexpected unindent.

</a> <a href='https://pepy.tech/project/term-image'>

System Message: ERROR/3 (<string>, line 24)

Unexpected indentation.

<img src="https://pepy.tech/badge/term-image/month">

System Message: WARNING/2 (<string>, line 25)

Block quote ends without a blank line; unexpected unindent.

</a> <a href='https://pypi.org/project/term-image/'>

System Message: ERROR/3 (<string>, line 27)

Unexpected indentation.

<img src='https://img.shields.io/pypi/pyversions/term-image.svg'>

System Message: WARNING/2 (<string>, line 28)

Block quote ends without a blank line; unexpected unindent.

</a> <a href='https://github.com/psf/black'>

System Message: ERROR/3 (<string>, line 30)

Unexpected indentation.

<img src='https://img.shields.io/badge/code%20style-black-000000.svg'>

System Message: WARNING/2 (<string>, line 31)

Block quote ends without a blank line; unexpected unindent.

</a> <a href='https://github.com/AnonymouX47/term-image/actions/workflows/test.yml'>

System Message: ERROR/3 (<string>, line 33)

Unexpected indentation.

<img src='https://github.com/AnonymouX47/term-image/actions/workflows/test.yml/badge.svg'>

System Message: WARNING/2 (<string>, line 34)

Block quote ends without a blank line; unexpected unindent.

</a> <a href='https://term-image.readthedocs.io'>

System Message: ERROR/3 (<string>, line 36)

Unexpected indentation.

<img src='https://readthedocs.org/projects/term-image/badge/?version=latest' alt='Documentation Status' />

System Message: WARNING/2 (<string>, line 37)

Block quote ends without a blank line; unexpected unindent.

</a> <img src="https://img.shields.io/github/last-commit/AnonymouX47/term-image"> <a href="https://twitter.com/intent/tweet?text=Display%20images%20in%20the%20terminal%20with%20Python&url=https://github.com/AnonymouX47/term-image&hashtags=developers,images,terminal,python">

System Message: ERROR/3 (<string>, line 40)

Unexpected indentation.

<img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social">

System Message: WARNING/2 (<string>, line 41)

Block quote ends without a blank line; unexpected unindent.

</a>

</p>

</div>

## Contents - [Installation](#installation) - [Features](#features) - [Demo](#demo) - [Quick Start](#library-quick-start) - [Usage](#usage) - [Contribution](#contribution) - [Planned Features](#planned-features) - [Known Issues](#known-issues) - [FAQs](#faqs) - [Credits](#credits) - [Sponsor This Project](#sponsor-this-project)

> ### ⚠️ NOTICE!!! ⚠️ > The image viewer (CLI and TUI) has been moved to [termvisage].

## Installation

### Requirements - Operating System: Unix / Linux / Mac OS X / Windows (limited support, see the [FAQs](https://term-image.readthedocs.io/en/stable/faqs.html)) - [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 [Planned Features](#planned-features)).

### Steps The latest stable version can be installed from [PyPI](https://pypi.org/project/term-image) with:

`shell pip install term-image `

The development version can be installed with:

`shell pip install git+https://github.com/AnonymouX47/term-image.git `

### Supported Terminal Emulators See [here](https://term-image.readthedocs.io/en/stable/start/installation.html#supported-terminal-emulators) for a list of tested terminal emulators.

If you've tested this library on any other terminal emulator that meets the requirements for any of the render styles, please mention the name (and version) in a new thread under [this discussion](https://github.com/AnonymouX47/term-image/discussions/4).

Also, if you have any issue with terminal support, you may report or check information about it in the discussion linked above.

## Features - Multiple image formats (basically all formats supported by [PIL.Image.open()](https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html)) - Multiple image source types: PIL image instance, local file, URL - Multiple image render styles (with automatic support detection) - Support for multiple terminal graphics protocols: [Kitty](https://sw.kovidgoyal.net/kitty/graphics-protocol/), [iTerm2](https://iterm2.com/documentation-images.html)

• Exposes various features of the protocols

• Transparency support (with multiple options)
• Animated image support (including transparent ones) - Multiple formats: GIF, WEBP, APNG (and possibly more) - Fully controllable iteration over rendered frames of animated images - Image animation with multiple parameters
• Integration into various TUI / terminal-based output libraries.
• Terminal size awareness
• Automatic and manual image sizing
• Horizontal and vertical alignment
• Automatic and manual font ratio adjustment (to preserve image aspect ratio)
• and more... 😁

## Demo

Check out this [image viewer][termvisage] based on this library.

## Quick Start

### Creating an instance

1. Initialize with a file path: ```python from term_image.image import from_file

   System Message: WARNING/2 (<string>, line 128); backlink

   Inline literal start-string without end-string.

   System Message: WARNING/2 (<string>, line 128); backlink

   Inline interpreted text or phrase reference start-string without end-string.

   image = from_file("path/to/image.png") ```

   System Message: WARNING/2 (<string>, line 132); backlink

   Inline literal start-string without end-string.

   System Message: WARNING/2 (<string>, line 132); backlink

   Inline interpreted text or phrase reference start-string without end-string.

2. Initialize with a URL: ```python from term_image.image import from_url

   System Message: WARNING/2 (<string>, line 135); backlink

   Inline literal start-string without end-string.

   System Message: WARNING/2 (<string>, line 135); backlink

   Inline interpreted text or phrase reference start-string without end-string.

   image = from_url("https://www.example.com/image.png") ```

   System Message: WARNING/2 (<string>, line 139); backlink

   Inline literal start-string without end-string.

   System Message: WARNING/2 (<string>, line 139); backlink

   Inline interpreted text or phrase reference start-string without end-string.

3. Initialize with a PIL (Pillow) image instance: ```python from PIL import Image from term_image.image import AutoImage

   System Message: WARNING/2 (<string>, line 142); backlink

   Inline literal start-string without end-string.

   System Message: WARNING/2 (<string>, line 142); backlink

   Inline interpreted text or phrase reference start-string without end-string.

   img = Image.open("path/to/image.png") image = AutoImage(img) ```

   System Message: WARNING/2 (<string>, line 147); backlink

   Inline literal start-string without end-string.

   System Message: WARNING/2 (<string>, line 147); backlink

   Inline interpreted text or phrase reference start-string without end-string.

### Drawing/Displaying an Image

There are two basic ways to draw an image to the terminal screen:

1. Using the draw() method: `python image.draw() ` NOTE: draw() has various parameters for render formatting.
2. Using print() with an image render output: `python print(image)  # without formatting # OR print(f"{image:>200.^100#ffffff}")  # with formatting `

For animated images, only the former animates the output, the latter only draws the current frame.

See the [tutorial](https://term-image.readthedocs.io/en/stable/start/tutorial.html) for a more detailed introduction.

## Usage

<p align="center"><b>

🚧 Under Construction - There will most likely be incompatible changes between minor versions of <a href='https://semver.org/spec/v2.0.0.html#spec-item-4'>version zero</a>!

</b></p>

If you want to use this library in a project while it's still on version zero, ensure you pin the dependency to a specific minor version e.g `>=0.4,<0.5`.

See the [docs](https://term-image.readthedocs.io) for the User Guide and API Reference.

## Contribution

Please read through the [guidelines](https://github.com/AnonymouX47/term-image/blob/main/CONTRIBUTING.md).

For code contributions, you should also check out the [Planned Features](#planned-features). If you wish to work on any of the listed features/improvements, please click on the linked issue or go through the [issues](https://github.com/AnonymouX47/term-image/issues) section and join in on an ongoing discussion about the task or create a new issue if one hasn't been created yet, so that the implementation can be discussed.

Hint: You can filter issues by label or simply search using the features's description.

Thanks! 💓

## Planned Features

See [here](https://term-image.readthedocs.io/en/stable/planned.html).

## Known Issues

See [here](https://term-image.readthedocs.io/en/stable/issues.html).

## FAQs

See the [FAQs](https://term-image.readthedocs.io/en/stable/faqs.html) section of the docs.

## Credits

The following projects have been (and are still) crucial to the development of this project: - [Pillow](https://python-pillow.org) by [Fredrik Lundh, Jeffrey A. Clark (Alex) and contributors](https://github.com/python-pillow/Pillow/graphs/contributors) - [Requests](https://requests.readthedocs.io) by [Kenneth Reitz and others](https://requests.readthedocs.io/en/latest/dev/authors/)

The logo was composed using resource(s) from the following source(s): - [Gallery icons created by Andrean Prabowo - Flaticon](https://www.flaticon.com/free-icons/gallery)

## Sponsor This Project

<a href="https://www.buymeacoffee.com/anonymoux47" target="_blank">

<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" >

</a>

Any amount will go a long way in aiding the progress and development of this project. Thank you! 💓

[termvisage]: https://github.com/AnonymouX47/termvisage