├── .gitignore ├── LICENSE ├── README.md ├── __init__.py ├── matplotlib-backend-kitty └── __init__.py └── pyproject.toml /.gitignore: -------------------------------------------------------------------------------- 1 | .pyc 2 | __pycache__ 3 | dist/ 4 | *.egg-info/ 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for th benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # matplotlib-backend-kitty 2 | 3 | This python module allows you to use your 4 | [kitty terminal](https://github.com/kovidgoyal/kitty) 5 | to show the plots generated by python's 6 | [matplotlib](https://github.com/matplotlib/matplotlib). 7 | 8 | For other terminals, the similar [notcurses backend](https://github.com/jktr/matplotlib-backend-notcurses) 9 | may also be of interest. 10 | 11 | To install this one, do one of the following 12 | 13 | - `$ pip install --user matplotlib-backend-kitty` 14 | - clone this repo into your python's `site-packages` directory 15 | - clone this repo and add the parent directory to `sys.path` or `$PYTHONPATH` 16 | 17 | Then, configure matplotlib to use the module by either setting the 18 | environment variable `MPLBACKEND` to `module://matplotlib-backend-kitty` 19 | or by initializing matplotlib as follows. 20 | 21 | ```python 22 | import matplotlib 23 | matplotlib.use('module://matplotlib-backend-kitty') 24 | import matplotlib.pyplot as plt 25 | ``` 26 | 27 | If you've installed this module correctly, you can now use 28 | the following sample code to draw a plot in your terminal. 29 | 30 | ``` 31 | $ export MPLBACKEND='module://matplotlib-backend-kitty' 32 | $ python 33 | >>> n = 10000 34 | >>> df = pd.DataFrame({'x': np.random.randn(n), 35 | 'y': np.random.randn(n)}) 36 | >>> df.plot.hexbin(x='x', y='y', gridsize=20) 37 | 38 | ``` 39 | 40 | If you set your matplotlib to interactive mode via 41 | `matplotlib.pyplot.ion()` or by running an interactive python 42 | shell like `python` or `ipython`, non-empty figures are drawn on 43 | construction where possible. This allows you to use pandas' 44 | `plot()` calls directly, without calling `plt.show()`, and still 45 | enables you to manually construct and `plt.show()`. 46 | 47 | If your matplotlib is in non-interactive mode, 48 | you can construct your figures as usual, and then call 49 | `plt.show()` to render them to your terminal. This 50 | works both from scripts and from a repl. 51 | 52 | Figures are resized to the size of your terminal by default. 53 | If you'd rather control the sizing of figures manually, 54 | set the `MPLBACKEND_KITTY_SIZING` environment variable to `manual`. 55 | 56 | Internally, this backend is somewhat based on matplotlib's 57 | IPython support: it's a hybrid of image and GUI backend types. 58 | It works by using matplotlib's `Agg` backend to render the 59 | plot, and then calls kitty's `icat` to place the rendered 60 | image on your terminal. This means that plotting works as 61 | expected, but the image drawn to your terminal isn't 62 | interactive and animations aren't supported. 63 | -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- 1 | matplotlib-backend-kitty/__init__.py -------------------------------------------------------------------------------- /matplotlib-backend-kitty/__init__.py: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: CC0-1.0 2 | 3 | import os 4 | import sys 5 | 6 | from io import BytesIO 7 | from subprocess import run 8 | 9 | from matplotlib import interactive, is_interactive 10 | from matplotlib._pylab_helpers import Gcf 11 | from matplotlib.backend_bases import (_Backend, FigureManagerBase) 12 | from matplotlib.backends.backend_agg import FigureCanvasAgg 13 | 14 | 15 | # XXX heuristic for interactive repl 16 | if hasattr(sys, 'ps1') or sys.flags.interactive: 17 | interactive(True) 18 | 19 | 20 | class FigureManagerICat(FigureManagerBase): 21 | 22 | @classmethod 23 | def _run(cls, *cmd): 24 | def f(*args, output=True, **kwargs): 25 | if output: 26 | kwargs['capture_output'] = True 27 | kwargs['text'] = True 28 | r = run(cmd + args, **kwargs) 29 | if output: 30 | return r.stdout.rstrip() 31 | return f 32 | 33 | def show(self): 34 | 35 | icat = __class__._run('kitty', '+kitten', 'icat') 36 | 37 | if os.environ.get('MPLBACKEND_KITTY_SIZING', 'automatic') != 'manual': 38 | 39 | tput = __class__._run('tput') 40 | 41 | # gather terminal dimensions 42 | rows = int(tput('lines')) 43 | px = icat('--print-window-size') 44 | px = list(map(int, px.split('x'))) 45 | 46 | # account for post-display prompt scrolling 47 | # 3 line shift for [\n, >>] after the figure 48 | px[1] -= int(3*(px[1]/rows)) 49 | 50 | # resize figure to terminal size & aspect ratio 51 | dpi = self.canvas.figure.dpi 52 | self.canvas.figure.set_size_inches((px[0] / dpi, px[1] / dpi)) 53 | 54 | with BytesIO() as buf: 55 | self.canvas.figure.savefig(buf, format='png') 56 | icat('--align', 'left', output=False, input=buf.getbuffer()) 57 | 58 | 59 | class FigureCanvasICat(FigureCanvasAgg): 60 | manager_class = FigureManagerICat 61 | 62 | 63 | @_Backend.export 64 | class _BackendICatAgg(_Backend): 65 | 66 | FigureCanvas = FigureCanvasICat 67 | FigureManager = FigureManagerICat 68 | 69 | # Noop function instead of None signals that 70 | # this is an "interactive" backend 71 | mainloop = lambda: None 72 | 73 | # XXX: `draw_if_interactive` isn't really intended for 74 | # on-shot rendering. We run the risk of being called 75 | # on a figure that isn't completely rendered yet, so 76 | # we skip draw calls for figures that we detect as 77 | # not being fully initialized yet. Our heuristic for 78 | # that is the presence of axes on the figure. 79 | @classmethod 80 | def draw_if_interactive(cls): 81 | manager = Gcf.get_active() 82 | if is_interactive() and manager.canvas.figure.get_axes(): 83 | cls.show() 84 | 85 | @classmethod 86 | def show(cls, *args, **kwargs): 87 | _Backend.show(*args, **kwargs) 88 | Gcf.destroy_all() 89 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "matplotlib-backend-kitty" 3 | version = "2.1.2" 4 | description = "show matplotlib plots directly in your kitty terminal" 5 | readme = "README.md" 6 | classifiers = [ 7 | "Programming Language :: Python :: 3", 8 | "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication", 9 | "Framework :: Matplotlib", 10 | "Topic :: Terminals", 11 | ] 12 | dependencies = [ "matplotlib" ] 13 | 14 | [project.urls] 15 | "Homepage" = "https://github.com/jktr/matplotlib-backend-kitty" 16 | "Bug Tracker" = "https://github.com/jktr/matplotlib-backend-kitty/issues" 17 | 18 | [build-system] 19 | requires = [ "setuptools>=61.0" ] 20 | build-backend = "setuptools.build_meta" 21 | 22 | [tool.setuptools.packages.find] 23 | where = [ "." ] 24 | --------------------------------------------------------------------------------