Skip to main content

Display images in Kitty-compatible terminals

Project description

ktcat

Display images in a Kitty-compatible terminal by writing Kitty graphics escape sequences to stdout.

What It Does

  • Library API: ktcat(image)
  • CLI: ktcat path/to/image.png [more files...]
  • Supported inputs in the library API include PIL images, NumPy arrays, and Torch tensors.

Development

  • Create or update the project environment with make sync.
  • Format: make format
  • Lint/typecheck: make lint
  • Run tests: make test

Notes

  • The package uses a src layout; src/ktcat/__main__.py forwards python -m ktcat to the same main() entrypoint used by the installed ktcat console script.
  • The published package has no required runtime dependencies. NumPy, Pillow, and Torch support are optional; this repo keeps them in the dev dependency group for tests.
  • The file-based CLI requires Pillow to open image files. NumPy-backed library inputs can be encoded without Pillow.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ktcat-0.1.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ktcat-0.1.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file ktcat-0.1.0.tar.gz.

File metadata

  • Download URL: ktcat-0.1.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for ktcat-0.1.0.tar.gz
Algorithm Hash digest
SHA256 003248908a5ec08ca147617a6e0921610dc0d52b48e0dd519af73f268f6a376b
MD5 9c4189fdf3040e1a2db1456a73c47e72
BLAKE2b-256 50b405bcf7e252850b813339d79cc92ad10fc9cd85443c84d3460192f53c41df

See more details on using hashes here.

File details

Details for the file ktcat-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ktcat-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for ktcat-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 419a91d49bbc25f262275e39bfa71c1b05ab893339eea94884510692aa50c316
MD5 0180713099918b194102ec50c811d847
BLAKE2b-256 fc88459d4f01672b7002cbf07068a3fa0ff85574415ba8700c73f941cc64a62c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page