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.1.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipython_icat-0.1.0.tar.gz
  • Upload date:
  • Size: 3.9 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.1.0.tar.gz
Algorithm Hash digest
SHA256 e96962a3848622ef4839c2e82c426204c5b021aeb44c76e4aaaa11c23e16ad59
MD5 2396a07abae6a4817ae4770fe66cd5df
BLAKE2b-256 a334cc20665b6ba897c34f42a93ecc2a35c87d47fc5525c36404267055a0f058

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ipython_icat-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45e6bcd0cd7ab3ec9c064d768684049ff768e166094f18e43f156aebfecfa46e
MD5 a22ff91231f22f7073a93395aaa59ff5
BLAKE2b-256 9a856fcde86d93a98fa1deffb2778ec7a62aa0daf7c2eb4270c08635e843be23

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