ipython-icat 0.0.2__tar.gz → 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2024 Tony Kabilan Okeke
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,101 @@
1
+ Metadata-Version: 2.1
2
+ Name: ipython-icat
3
+ Version: 0.1.0
4
+ Summary: IPython magic command for displaying images in kitty terminal
5
+ Author-email: Tony Kabilan Okeke <tonykabilanokeke@gmail.com>
6
+ Project-URL: Homepage, https://github.com/Kabilan108/ipython-icat
7
+ Keywords: ipython,magic,image,display,kitty,icat
8
+ Requires-Python: >=3.9
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE.md
11
+ Requires-Dist: ipython>=8.18.1
12
+ Requires-Dist: matplotlib>=3.9.2
13
+ Requires-Dist: pillow>=10.4.0
14
+
15
+ # ipython-icat
16
+
17
+ [![PyPI version](https://img.shields.io/pypi/v/ipython-icat.svg?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/ipython-icat/)
18
+
19
+ ## Installation
20
+
21
+ You can install `ipython-icat` using pip:
22
+
23
+ ```bash
24
+ pip install ipython-icat
25
+ ```
26
+
27
+ ## Requirements
28
+
29
+ - Python 3.9+
30
+ - IPython
31
+ - matplotlib
32
+ - Pillow (PIL)
33
+ - kitty terminal
34
+
35
+ ## Usage
36
+
37
+ ### Loading the Extension
38
+
39
+ In your IPython session, load the extension:
40
+
41
+ ```python
42
+ %load_ext icat
43
+ ```
44
+
45
+ ### Displaying Matplotlib Plots
46
+
47
+ To use the kitty backend for matplotlib:
48
+
49
+ ```python
50
+ %plt_icat
51
+ ```
52
+
53
+ After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.
54
+
55
+ ### Displaying Images
56
+
57
+ To display an image file or a PIL Image object:
58
+
59
+ ```python
60
+ %icat path/to/your/image.jpg
61
+ ```
62
+
63
+ or
64
+
65
+ ```python
66
+ from PIL import Image
67
+ img = Image.open('path/to/your/image.jpg')
68
+ %icat img
69
+ ```
70
+
71
+ You can also resize the image when displaying:
72
+
73
+ ```python
74
+ %icat path/to/your/image.jpg -w 300 -h 200
75
+ ```
76
+
77
+ ## Features
78
+
79
+ - Display matplotlib plots directly in kitty terminal
80
+ - Show PIL Image objects or image files
81
+ - Resize images on display
82
+ - Seamless integration with IPython workflow
83
+
84
+ ## Contributing
85
+
86
+ Contributions are welcome! Please feel free to submit a Pull Request.
87
+
88
+ ## License
89
+
90
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
91
+
92
+ ## Acknowledgments
93
+
94
+ - [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
95
+ - [matplotlib](https://github.com/matplotlib/matplotlib) and [Pillow](https://python-pillow.org/) for their excellent libraries
96
+ - [kitty terminal](https://github.com/kovidgoyal/kitty) for supporting image protocol
97
+
98
+ ## Contact
99
+
100
+ If you have any questions or feedback, please open an issue on the GitHub repository.
101
+
@@ -0,0 +1,87 @@
1
+ # ipython-icat
2
+
3
+ [![PyPI version](https://img.shields.io/pypi/v/ipython-icat.svg?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/ipython-icat/)
4
+
5
+ ## Installation
6
+
7
+ You can install `ipython-icat` using pip:
8
+
9
+ ```bash
10
+ pip install ipython-icat
11
+ ```
12
+
13
+ ## Requirements
14
+
15
+ - Python 3.9+
16
+ - IPython
17
+ - matplotlib
18
+ - Pillow (PIL)
19
+ - kitty terminal
20
+
21
+ ## Usage
22
+
23
+ ### Loading the Extension
24
+
25
+ In your IPython session, load the extension:
26
+
27
+ ```python
28
+ %load_ext icat
29
+ ```
30
+
31
+ ### Displaying Matplotlib Plots
32
+
33
+ To use the kitty backend for matplotlib:
34
+
35
+ ```python
36
+ %plt_icat
37
+ ```
38
+
39
+ After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.
40
+
41
+ ### Displaying Images
42
+
43
+ To display an image file or a PIL Image object:
44
+
45
+ ```python
46
+ %icat path/to/your/image.jpg
47
+ ```
48
+
49
+ or
50
+
51
+ ```python
52
+ from PIL import Image
53
+ img = Image.open('path/to/your/image.jpg')
54
+ %icat img
55
+ ```
56
+
57
+ You can also resize the image when displaying:
58
+
59
+ ```python
60
+ %icat path/to/your/image.jpg -w 300 -h 200
61
+ ```
62
+
63
+ ## Features
64
+
65
+ - Display matplotlib plots directly in kitty terminal
66
+ - Show PIL Image objects or image files
67
+ - Resize images on display
68
+ - Seamless integration with IPython workflow
69
+
70
+ ## Contributing
71
+
72
+ Contributions are welcome! Please feel free to submit a Pull Request.
73
+
74
+ ## License
75
+
76
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
77
+
78
+ ## Acknowledgments
79
+
80
+ - [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
81
+ - [matplotlib](https://github.com/matplotlib/matplotlib) and [Pillow](https://python-pillow.org/) for their excellent libraries
82
+ - [kitty terminal](https://github.com/kovidgoyal/kitty) for supporting image protocol
83
+
84
+ ## Contact
85
+
86
+ If you have any questions or feedback, please open an issue on the GitHub repository.
87
+
@@ -0,0 +1,101 @@
1
+ Metadata-Version: 2.1
2
+ Name: ipython-icat
3
+ Version: 0.1.0
4
+ Summary: IPython magic command for displaying images in kitty terminal
5
+ Author-email: Tony Kabilan Okeke <tonykabilanokeke@gmail.com>
6
+ Project-URL: Homepage, https://github.com/Kabilan108/ipython-icat
7
+ Keywords: ipython,magic,image,display,kitty,icat
8
+ Requires-Python: >=3.9
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE.md
11
+ Requires-Dist: ipython>=8.18.1
12
+ Requires-Dist: matplotlib>=3.9.2
13
+ Requires-Dist: pillow>=10.4.0
14
+
15
+ # ipython-icat
16
+
17
+ [![PyPI version](https://img.shields.io/pypi/v/ipython-icat.svg?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/ipython-icat/)
18
+
19
+ ## Installation
20
+
21
+ You can install `ipython-icat` using pip:
22
+
23
+ ```bash
24
+ pip install ipython-icat
25
+ ```
26
+
27
+ ## Requirements
28
+
29
+ - Python 3.9+
30
+ - IPython
31
+ - matplotlib
32
+ - Pillow (PIL)
33
+ - kitty terminal
34
+
35
+ ## Usage
36
+
37
+ ### Loading the Extension
38
+
39
+ In your IPython session, load the extension:
40
+
41
+ ```python
42
+ %load_ext icat
43
+ ```
44
+
45
+ ### Displaying Matplotlib Plots
46
+
47
+ To use the kitty backend for matplotlib:
48
+
49
+ ```python
50
+ %plt_icat
51
+ ```
52
+
53
+ After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.
54
+
55
+ ### Displaying Images
56
+
57
+ To display an image file or a PIL Image object:
58
+
59
+ ```python
60
+ %icat path/to/your/image.jpg
61
+ ```
62
+
63
+ or
64
+
65
+ ```python
66
+ from PIL import Image
67
+ img = Image.open('path/to/your/image.jpg')
68
+ %icat img
69
+ ```
70
+
71
+ You can also resize the image when displaying:
72
+
73
+ ```python
74
+ %icat path/to/your/image.jpg -w 300 -h 200
75
+ ```
76
+
77
+ ## Features
78
+
79
+ - Display matplotlib plots directly in kitty terminal
80
+ - Show PIL Image objects or image files
81
+ - Resize images on display
82
+ - Seamless integration with IPython workflow
83
+
84
+ ## Contributing
85
+
86
+ Contributions are welcome! Please feel free to submit a Pull Request.
87
+
88
+ ## License
89
+
90
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
91
+
92
+ ## Acknowledgments
93
+
94
+ - [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
95
+ - [matplotlib](https://github.com/matplotlib/matplotlib) and [Pillow](https://python-pillow.org/) for their excellent libraries
96
+ - [kitty terminal](https://github.com/kovidgoyal/kitty) for supporting image protocol
97
+
98
+ ## Contact
99
+
100
+ If you have any questions or feedback, please open an issue on the GitHub repository.
101
+
@@ -1,3 +1,4 @@
1
+ LICENSE.md
1
2
  README.md
2
3
  pyproject.toml
3
4
  icat/__init__.py
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "ipython-icat"
3
- version = "0.0.2"
3
+ version = "0.1.0"
4
4
  description = "IPython magic command for displaying images in kitty terminal"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.9"
@@ -1,19 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: ipython-icat
3
- Version: 0.0.2
4
- Summary: IPython magic command for displaying images in kitty terminal
5
- Author-email: Tony Kabilan Okeke <tonykabilanokeke@gmail.com>
6
- Project-URL: Homepage, https://github.com/Kabilan108/ipython-icat
7
- Keywords: ipython,magic,image,display,kitty,icat
8
- Requires-Python: >=3.9
9
- Description-Content-Type: text/markdown
10
- Requires-Dist: ipython>=8.18.1
11
- Requires-Dist: matplotlib>=3.9.2
12
- Requires-Dist: pillow>=10.4.0
13
-
14
- # ipython-icat
15
-
16
- This Python module enables you to display plots created with [matplotlib](https://github.com/matplotlib/matplotlib) and [PIL](https://python-pillow.org/) Image objects directly in your [kitty terminal](https://github.com/kovidgoyal/kitty) when using IPython.
17
-
18
- This is modified from [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) but is designed to be used via IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html).
19
-
@@ -1,6 +0,0 @@
1
- # ipython-icat
2
-
3
- This Python module enables you to display plots created with [matplotlib](https://github.com/matplotlib/matplotlib) and [PIL](https://python-pillow.org/) Image objects directly in your [kitty terminal](https://github.com/kovidgoyal/kitty) when using IPython.
4
-
5
- This is modified from [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) but is designed to be used via IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html).
6
-
@@ -1,19 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: ipython-icat
3
- Version: 0.0.2
4
- Summary: IPython magic command for displaying images in kitty terminal
5
- Author-email: Tony Kabilan Okeke <tonykabilanokeke@gmail.com>
6
- Project-URL: Homepage, https://github.com/Kabilan108/ipython-icat
7
- Keywords: ipython,magic,image,display,kitty,icat
8
- Requires-Python: >=3.9
9
- Description-Content-Type: text/markdown
10
- Requires-Dist: ipython>=8.18.1
11
- Requires-Dist: matplotlib>=3.9.2
12
- Requires-Dist: pillow>=10.4.0
13
-
14
- # ipython-icat
15
-
16
- This Python module enables you to display plots created with [matplotlib](https://github.com/matplotlib/matplotlib) and [PIL](https://python-pillow.org/) Image objects directly in your [kitty terminal](https://github.com/kovidgoyal/kitty) when using IPython.
17
-
18
- This is modified from [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) but is designed to be used via IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html).
19
-
File without changes