| Name | ipython-icat JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | IPython magic command for displaying images in kitty terminal |
| upload_time | 2024-10-22 05:32:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
ipython
magic
image
display
kitty
icat
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ipython-icat
[](https://pypi.org/project/ipython-icat/)
## Installation
You can install `ipython-icat` using pip:
```bash
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:
```python
%load_ext icat
```
### Displaying Matplotlib Plots
To use the kitty backend for matplotlib:
```python
%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:
```python
%icat path/to/your/image.jpg
```
or
```python
from PIL import Image
img = Image.open('path/to/your/image.jpg')
%icat img
```
You can also resize the image when displaying:
```python
%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](LICENSE) file for details.
## Acknowledgments
- [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
- [matplotlib](https://github.com/matplotlib/matplotlib) and [Pillow](https://python-pillow.org/) for their excellent libraries
- [kitty terminal](https://github.com/kovidgoyal/kitty) for supporting image protocol
## Contact
If you have any questions or feedback, please open an issue on the GitHub repository.
Raw data
{
"_id": null,
"home_page": null,
"name": "ipython-icat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ipython, magic, image, display, kitty, icat",
"author": null,
"author_email": "Tony Kabilan Okeke <tonykabilanokeke@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/74/7a/5c3e81e90c638ce602ba322265e1d0311040cf41d9a311a55494f9644141/ipython_icat-0.2.2.tar.gz",
"platform": null,
"description": "# ipython-icat\n\n[](https://pypi.org/project/ipython-icat/)\n\n## Installation\n\nYou can install `ipython-icat` using pip:\n\n```bash\npip install ipython-icat\n```\n\n## Requirements\n\n- Python 3.9+\n- IPython\n- matplotlib\n- Pillow (PIL)\n- kitty terminal\n\n## Usage\n\n### Loading the Extension\n\nIn your IPython session, load the extension:\n\n```python\n%load_ext icat\n```\n\n### Displaying Matplotlib Plots\n\nTo use the kitty backend for matplotlib:\n\n```python\n%plt_icat\n```\n\nAfter running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.\n\n### Displaying Images\n\nTo display an image file or a PIL Image object:\n\n```python\n%icat path/to/your/image.jpg\n```\n\nor\n\n```python\nfrom PIL import Image\nimg = Image.open('path/to/your/image.jpg')\n%icat img\n```\n\nYou can also resize the image when displaying:\n\n```python\n%icat path/to/your/image.jpg -w 300 -h 200\n```\n\n## Features\n\n- Display matplotlib plots directly in kitty terminal\n- Show PIL Image objects or image files\n- Resize images on display\n- Seamless integration with IPython workflow\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation\n- [matplotlib](https://github.com/matplotlib/matplotlib) and [Pillow](https://python-pillow.org/) for their excellent libraries\n- [kitty terminal](https://github.com/kovidgoyal/kitty) for supporting image protocol\n\n## Contact\n\nIf you have any questions or feedback, please open an issue on the GitHub repository.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "IPython magic command for displaying images in kitty terminal",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/Kabilan108/ipython-icat"
},
"split_keywords": [
"ipython",
" magic",
" image",
" display",
" kitty",
" icat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e6fdbcc09544f7b8b22fb06d85c60ba4506abe1999f54658580374c66c324c5",
"md5": "8f6f33a30a44cfaa9237ce3d7fe701ef",
"sha256": "86c3b6174af39d191b882400f6a9ebe332c0113ab24e79527e014aca9940875b"
},
"downloads": -1,
"filename": "ipython_icat-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f6f33a30a44cfaa9237ce3d7fe701ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4193,
"upload_time": "2024-10-22T05:32:01",
"upload_time_iso_8601": "2024-10-22T05:32:01.184147Z",
"url": "https://files.pythonhosted.org/packages/9e/6f/dbcc09544f7b8b22fb06d85c60ba4506abe1999f54658580374c66c324c5/ipython_icat-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "747a5c3e81e90c638ce602ba322265e1d0311040cf41d9a311a55494f9644141",
"md5": "f910a813f13a4e6964ba260b02759551",
"sha256": "1985ce0812de41e91dc1075b81304169c75157233db2a06ccc444ced5fe1a5ab"
},
"downloads": -1,
"filename": "ipython_icat-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f910a813f13a4e6964ba260b02759551",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3936,
"upload_time": "2024-10-22T05:32:02",
"upload_time_iso_8601": "2024-10-22T05:32:02.688277Z",
"url": "https://files.pythonhosted.org/packages/74/7a/5c3e81e90c638ce602ba322265e1d0311040cf41d9a311a55494f9644141/ipython_icat-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 05:32:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kabilan108",
"github_project": "ipython-icat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipython-icat"
}
