Metadata-Version: 2.4
Name: tiv
Version: 0.3.1
Summary: Render images as ANSI colors in a terminal
Author-email: Predrag Mandic <predrag@nul.one>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://gitlab.nul.one/mush/tiv
Project-URL: Repository, https://gitlab.nul.one/mush/tiv.git
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Graphics :: Viewers
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: CairoSVG>=2.7
Requires-Dist: click>=8.1
Requires-Dist: Pillow>=10.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: ruff>=0.8; extra == "dev"
Dynamic: license-file

Terminal Image Viewer
==================================================
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

Render JPEG, PNG, GIF, and SVG images as ANSI colors in a terminal.

Source: https://gitlab.nul.one/mush/tiv

Installation
-------------------------

### Install with pipx (recommended)

```console
pipx install tiv
```

### Install from a checkout

```console
pipx install .
```

### Install from git

```console
pipx install git+https://gitlab.nul.one/mush/tiv.git
```

For development, install the package and its test and lint tools into a virtual
environment:

```console
python3 -m venv .venv
.venv/bin/python -m pip install --upgrade pip
.venv/bin/python -m pip install -e '.[dev]'
```

Usage
-------------------------

`tiv [OPTIONS] IMAGE [IMAGE [IMAGE...]]`

### Options

- `-w, --width INTEGER` - Set image width in number of terminal characters. Defaults to the current terminal width.
- `-a, --aspect-ratio FLOAT` - Specify character aspect ratio (width:hight). Default is 0.5.

Development
-------------------------

```console
python -m pytest
python -m ruff check .
python -m ruff format --check .
python -m build
```
