ipython-icat 0.2.1__tar.gz → 0.2.3__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.
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: ipython-icat
3
- Version: 0.2.1
3
+ Version: 0.2.3
4
4
  Summary: IPython magic command for displaying images in kitty terminal
5
5
  Author-email: Tony Kabilan Okeke <tonykabilanokeke@gmail.com>
6
6
  Project-URL: Homepage, https://github.com/Kabilan108/ipython-icat
@@ -8,9 +8,10 @@ Keywords: ipython,magic,image,display,kitty,icat
8
8
  Requires-Python: >=3.9
9
9
  Description-Content-Type: text/markdown
10
10
  License-File: LICENSE.md
11
- Requires-Dist: ipython>=8.18.1
12
- Requires-Dist: matplotlib>=3.9.2
13
- Requires-Dist: pillow>=9.0.0
11
+ Requires-Dist: ipython
12
+ Requires-Dist: matplotlib
13
+ Requires-Dist: pillow
14
+ Dynamic: license-file
14
15
 
15
16
  # ipython-icat
16
17
 
@@ -30,7 +31,7 @@ pip install ipython-icat
30
31
  - IPython
31
32
  - matplotlib
32
33
  - Pillow (PIL)
33
- - kitty terminal
34
+ - terminal emulator with support for kitty graphics protocol (KGP) e.g., kitty, ghostty
34
35
 
35
36
  ## Usage
36
37
 
@@ -52,6 +53,13 @@ To use the kitty backend for matplotlib:
52
53
 
53
54
  After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.
54
55
 
56
+ ### Use as a Default Backend
57
+
58
+ To set the kitty backend for matplotlib as the default, add the following lines to your IPython configuration file:
59
+
60
+ 1. `c.InteractiveShellApp.extensions = ['icat']`
61
+ 2. `c.InteractiveShellApp.exec_lines = ['%plt_icat']`
62
+
55
63
  ### Displaying Images
56
64
 
57
65
  To display an image file or a PIL Image object:
@@ -74,6 +82,10 @@ You can also resize the image when displaying:
74
82
  %icat path/to/your/image.jpg -w 300 -h 200
75
83
  ```
76
84
 
85
+ ### Using Ghostty
86
+
87
+ If you'd like to use this plugin with Ghostty, make sure to install the [static kitten binary](https://github.com/kovidgoyal/kitty/releases) which will allow you to run `kitten icat`.
88
+
77
89
  ## Features
78
90
 
79
91
  - Display matplotlib plots directly in kitty terminal
@@ -85,17 +97,12 @@ You can also resize the image when displaying:
85
97
 
86
98
  Contributions are welcome! Please feel free to submit a Pull Request.
87
99
 
88
- ## License
89
-
90
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
91
-
92
100
  ## Acknowledgments
93
101
 
94
102
  - [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
95
103
  - [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
104
+ - [kitty terminal](https://github.com/kovidgoyal/kitty) for developing the graphics protocol
97
105
 
98
- ## Contact
99
-
100
- If you have any questions or feedback, please open an issue on the GitHub repository.
106
+ ## License
101
107
 
108
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -16,7 +16,7 @@ pip install ipython-icat
16
16
  - IPython
17
17
  - matplotlib
18
18
  - Pillow (PIL)
19
- - kitty terminal
19
+ - terminal emulator with support for kitty graphics protocol (KGP) e.g., kitty, ghostty
20
20
 
21
21
  ## Usage
22
22
 
@@ -38,6 +38,13 @@ To use the kitty backend for matplotlib:
38
38
 
39
39
  After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.
40
40
 
41
+ ### Use as a Default Backend
42
+
43
+ To set the kitty backend for matplotlib as the default, add the following lines to your IPython configuration file:
44
+
45
+ 1. `c.InteractiveShellApp.extensions = ['icat']`
46
+ 2. `c.InteractiveShellApp.exec_lines = ['%plt_icat']`
47
+
41
48
  ### Displaying Images
42
49
 
43
50
  To display an image file or a PIL Image object:
@@ -60,6 +67,10 @@ You can also resize the image when displaying:
60
67
  %icat path/to/your/image.jpg -w 300 -h 200
61
68
  ```
62
69
 
70
+ ### Using Ghostty
71
+
72
+ If you'd like to use this plugin with Ghostty, make sure to install the [static kitten binary](https://github.com/kovidgoyal/kitty/releases) which will allow you to run `kitten icat`.
73
+
63
74
  ## Features
64
75
 
65
76
  - Display matplotlib plots directly in kitty terminal
@@ -71,17 +82,12 @@ You can also resize the image when displaying:
71
82
 
72
83
  Contributions are welcome! Please feel free to submit a Pull Request.
73
84
 
74
- ## License
75
-
76
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
77
-
78
85
  ## Acknowledgments
79
86
 
80
87
  - [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
81
88
  - [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
89
+ - [kitty terminal](https://github.com/kovidgoyal/kitty) for developing the graphics protocol
83
90
 
84
- ## Contact
85
-
86
- If you have any questions or feedback, please open an issue on the GitHub repository.
91
+ ## License
87
92
 
93
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -32,7 +32,7 @@ def _run(*cmd):
32
32
  return f
33
33
 
34
34
 
35
- _icat = _run("kitty", "+kitten", "icat", "--align", "left")
35
+ _icat = _run("kitten", "icat", "--align", "left")
36
36
 
37
37
 
38
38
  class FigureManagerICat(FigureManagerBase):
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: ipython-icat
3
- Version: 0.2.1
3
+ Version: 0.2.3
4
4
  Summary: IPython magic command for displaying images in kitty terminal
5
5
  Author-email: Tony Kabilan Okeke <tonykabilanokeke@gmail.com>
6
6
  Project-URL: Homepage, https://github.com/Kabilan108/ipython-icat
@@ -8,9 +8,10 @@ Keywords: ipython,magic,image,display,kitty,icat
8
8
  Requires-Python: >=3.9
9
9
  Description-Content-Type: text/markdown
10
10
  License-File: LICENSE.md
11
- Requires-Dist: ipython>=8.18.1
12
- Requires-Dist: matplotlib>=3.9.2
13
- Requires-Dist: pillow>=9.0.0
11
+ Requires-Dist: ipython
12
+ Requires-Dist: matplotlib
13
+ Requires-Dist: pillow
14
+ Dynamic: license-file
14
15
 
15
16
  # ipython-icat
16
17
 
@@ -30,7 +31,7 @@ pip install ipython-icat
30
31
  - IPython
31
32
  - matplotlib
32
33
  - Pillow (PIL)
33
- - kitty terminal
34
+ - terminal emulator with support for kitty graphics protocol (KGP) e.g., kitty, ghostty
34
35
 
35
36
  ## Usage
36
37
 
@@ -52,6 +53,13 @@ To use the kitty backend for matplotlib:
52
53
 
53
54
  After running this command, any matplotlib plots you create will be displayed directly in your kitty terminal.
54
55
 
56
+ ### Use as a Default Backend
57
+
58
+ To set the kitty backend for matplotlib as the default, add the following lines to your IPython configuration file:
59
+
60
+ 1. `c.InteractiveShellApp.extensions = ['icat']`
61
+ 2. `c.InteractiveShellApp.exec_lines = ['%plt_icat']`
62
+
55
63
  ### Displaying Images
56
64
 
57
65
  To display an image file or a PIL Image object:
@@ -74,6 +82,10 @@ You can also resize the image when displaying:
74
82
  %icat path/to/your/image.jpg -w 300 -h 200
75
83
  ```
76
84
 
85
+ ### Using Ghostty
86
+
87
+ If you'd like to use this plugin with Ghostty, make sure to install the [static kitten binary](https://github.com/kovidgoyal/kitty/releases) which will allow you to run `kitten icat`.
88
+
77
89
  ## Features
78
90
 
79
91
  - Display matplotlib plots directly in kitty terminal
@@ -85,17 +97,12 @@ You can also resize the image when displaying:
85
97
 
86
98
  Contributions are welcome! Please feel free to submit a Pull Request.
87
99
 
88
- ## License
89
-
90
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
91
-
92
100
  ## Acknowledgments
93
101
 
94
102
  - [matplotlib-backend-kitty](https://github.com/jktr/matplotlib-backend-kitty) for the original implementation
95
103
  - [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
104
+ - [kitty terminal](https://github.com/kovidgoyal/kitty) for developing the graphics protocol
97
105
 
98
- ## Contact
99
-
100
- If you have any questions or feedback, please open an issue on the GitHub repository.
106
+ ## License
101
107
 
108
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -0,0 +1,3 @@
1
+ ipython
2
+ matplotlib
3
+ pillow
@@ -1,13 +1,13 @@
1
1
  [project]
2
2
  name = "ipython-icat"
3
- version = "0.2.1"
3
+ version = "0.2.3"
4
4
  description = "IPython magic command for displaying images in kitty terminal"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.9"
7
7
  dependencies = [
8
- "ipython>=8.18.1",
9
- "matplotlib>=3.9.2",
10
- "pillow>=9.0.0",
8
+ "ipython",
9
+ "matplotlib",
10
+ "pillow",
11
11
  ]
12
12
  authors = [
13
13
  { name = "Tony Kabilan Okeke", email = "tonykabilanokeke@gmail.com" }
@@ -1,3 +0,0 @@
1
- ipython>=8.18.1
2
- matplotlib>=3.9.2
3
- pillow>=9.0.0
File without changes
File without changes