Skip to main content

IPython magic command for displaying images in kitty terminal

Project description

ipython-icat

PyPI version

Installation

You can install ipython-icat using pip:

pip install ipython-icat

Requirements

  • Python 3.9+
  • IPython
  • matplotlib
  • Pillow (PIL)
  • kitty terminal

Usage

Loading the Extension

In your IPython session, load the extension:

%load_ext icat

Displaying Matplotlib Plots

To use the kitty backend for matplotlib:

%plt_icat

After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.

Displaying Images

To display an image file or a PIL Image object:

%icat path/to/your/image.jpg

or

from PIL import Image
img = Image.open('path/to/your/image.jpg')
%icat img

You can also resize the image when displaying:

%icat path/to/your/image.jpg -w 300 -h 200

Features

  • Display matplotlib plots directly in kitty terminal
  • Show PIL Image objects or image files
  • Resize images on display
  • Seamless integration with IPython workflow

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Contact

If you have any questions or feedback, please open an issue on the GitHub repository.

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

ipython_icat-0.2.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

ipython_icat-0.2.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file ipython_icat-0.2.0.tar.gz.

File metadata

  • Download URL: ipython_icat-0.2.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for ipython_icat-0.2.0.tar.gz
Algorithm Hash digest
SHA256 df60c1053527cd10a2c3048d0e772fb371a43a4bf9c98d9c8cf423ecece6a38a
MD5 c6ace5fe4983b314a77b240d4c2bcb8e
BLAKE2b-256 a9af36e6dfdd0d84ed1353de7551abed04e670955ecf9d2b6648ee868b39b551

See more details on using hashes here.

File details

Details for the file ipython_icat-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ipython_icat-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 df7e354aae7082a5e4f0de31041942e22691b7e5c04a4c6d44b3e15f0eb3171f
MD5 e65b98329e514cf4a80e8f00f14cea35
BLAKE2b-256 c080411d7c0cd83881e41589705bc50850593d37ea2bf2db2374c45acee63d36

See more details on using hashes here.

Supported by

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