mplsixel 1.0.0__tar.gz

mplsixel-1.0.0/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for th benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

mplsixel-1.0.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: mplsixel
+Version: 1.0.0
+Summary: show matplotlib plots directly in your sixel-enabled terminal
+Project-URL: Homepage, https://codeberg.org/paulw/mplsixel
+Project-URL: Bug Tracker, https://codeberg.org/paulw/mplsixel/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: Framework :: Matplotlib
+Classifier: Topic :: Terminals
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+# matplotlib-backend-sixel
+
+A fork of [matplotlib-backend-sixel](https://github.com/ctorney/matplotlib-backend-sixel)
+
+This python module allows you to use your
+[sixel-enabled terminal](https://www.arewesixelyet.com/)
+to show inline plots generated by python's
+[matplotlib](https://github.com/matplotlib/matplotlib).
+
+The module is a modified version of the [kitty backend](https://github.com/jktr/matplotlib-backend-kitty) and is also based on this 
+earlier [sixel backend](https://github.com/jonathf/matplotlib-sixel).
+
+You will need a terminal that has support for the SIXEL graphics format and [imagemagick](https://imagemagick.org/index.php) installed. 
+
+To install either run
+
+ - `$ pip install --user mplsixel`
+
+or clone this repo and run
+ - `$ cd mplsixel && pip install . `
+
+Configure matplotlib to use the module by either setting the
+environment variable `MPLBACKEND` to `module://matplotlib-backend-sixel`
+or by initializing matplotlib as follows.
+
+```python
+import matplotlib
+matplotlib.use('module://mplsixel')
+import matplotlib.pyplot as plt
+```
+
+You can also use the 
+```python
+%matplotlib sixel```
+line magic to switch to mplsixel backend in e.g. ipython consoles.
+
+If you've installed this module correctly, you can now use
+the following sample code to draw a plot in your terminal.
+
+```
+$ ipython
+In [1]: import matplotlib
+   ...: matplotlib.use('module://mplsixel')
+   ...: import numpy as np
+   ...: import matplotlib.pyplot as plt
+   ...: plt.style.use("dark_background")
+   ...: t = np.linspace(0,5,200)
+   ...: plt.fill_between(t,np.sin(t),np.cos(2*t),alpha=0.5)
+   ...: plt.fill_between(t,np.cos(t),np.sin(2*t),alpha=0.5)
+   ...: plt.show()
+
+<plot is shown>
+```
+
+Example output using Gnome terminal [compiled with SIXEL support](https://github.com/mate-desktop/mate-terminal/issues/410)
+
+![Example output](resources/demo.png)
+
+If you set your matplotlib to interactive mode via
+`matplotlib.pyplot.ion()` or by running python as
+`python -i`, non-empty figures are drawn on construction
+where possible. This allows you to use pandas' `plot()`
+calls directly, without calling `plt.show()`, and still
+enables you to manually construct and `plt.show()`.
+
+If your matplotlib is in non-interactive mode,
+you can construct your figures as usual, and then call
+`plt.show()` to render them to your terminal. This
+works from both a repl and when running scripts.
+
+Internally, this backend is somewhat based on matplotlib's
+IPython support: it's a hybrid of image and GUI backend types.
+It works by using matplotlib's `Agg` backend to render the
+plot, and then calls `imagemagick` to convert to sixel format 
+and then cat the image to your terminal. This means that plotting works as
+expected, but the image drawn to your terminal isn't
+interactive and animations aren't supported.

mplsixel-1.0.0/README.md

@@ -0,0 +1,77 @@
+# matplotlib-backend-sixel
+
+A fork of [matplotlib-backend-sixel](https://github.com/ctorney/matplotlib-backend-sixel)
+
+This python module allows you to use your
+[sixel-enabled terminal](https://www.arewesixelyet.com/)
+to show inline plots generated by python's
+[matplotlib](https://github.com/matplotlib/matplotlib).
+
+The module is a modified version of the [kitty backend](https://github.com/jktr/matplotlib-backend-kitty) and is also based on this 
+earlier [sixel backend](https://github.com/jonathf/matplotlib-sixel).
+
+You will need a terminal that has support for the SIXEL graphics format and [imagemagick](https://imagemagick.org/index.php) installed. 
+
+To install either run
+
+ - `$ pip install --user mplsixel`
+
+or clone this repo and run
+ - `$ cd mplsixel && pip install . `
+
+Configure matplotlib to use the module by either setting the
+environment variable `MPLBACKEND` to `module://matplotlib-backend-sixel`
+or by initializing matplotlib as follows.
+
+```python
+import matplotlib
+matplotlib.use('module://mplsixel')
+import matplotlib.pyplot as plt
+```
+
+You can also use the 
+```python
+%matplotlib sixel```
+line magic to switch to mplsixel backend in e.g. ipython consoles.
+
+If you've installed this module correctly, you can now use
+the following sample code to draw a plot in your terminal.
+
+```
+$ ipython
+In [1]: import matplotlib
+   ...: matplotlib.use('module://mplsixel')
+   ...: import numpy as np
+   ...: import matplotlib.pyplot as plt
+   ...: plt.style.use("dark_background")
+   ...: t = np.linspace(0,5,200)
+   ...: plt.fill_between(t,np.sin(t),np.cos(2*t),alpha=0.5)
+   ...: plt.fill_between(t,np.cos(t),np.sin(2*t),alpha=0.5)
+   ...: plt.show()
+
+<plot is shown>
+```
+
+Example output using Gnome terminal [compiled with SIXEL support](https://github.com/mate-desktop/mate-terminal/issues/410)
+
+![Example output](resources/demo.png)
+
+If you set your matplotlib to interactive mode via
+`matplotlib.pyplot.ion()` or by running python as
+`python -i`, non-empty figures are drawn on construction
+where possible. This allows you to use pandas' `plot()`
+calls directly, without calling `plt.show()`, and still
+enables you to manually construct and `plt.show()`.
+
+If your matplotlib is in non-interactive mode,
+you can construct your figures as usual, and then call
+`plt.show()` to render them to your terminal. This
+works from both a repl and when running scripts.
+
+Internally, this backend is somewhat based on matplotlib's
+IPython support: it's a hybrid of image and GUI backend types.
+It works by using matplotlib's `Agg` backend to render the
+plot, and then calls `imagemagick` to convert to sixel format 
+and then cat the image to your terminal. This means that plotting works as
+expected, but the image drawn to your terminal isn't
+interactive and animations aren't supported.

mplsixel-1.0.0/mplsixel/__init__.py

@@ -0,0 +1,3 @@
+from mplsixel.backend import FigureCanvas, FigureManager, show
+
+__all__ = ["FigureCanvas", "FigureManager", "show"]

mplsixel-1.0.0/mplsixel/backend.py

@@ -0,0 +1,88 @@
+# SPDX-License-Identifier: CC0-1.0
+
+import sys
+
+from subprocess import Popen, PIPE
+import warnings
+
+from matplotlib import interactive, is_interactive
+from matplotlib._pylab_helpers import Gcf
+from matplotlib.backend_bases import _Backend, FigureManagerBase
+from matplotlib.backends.backend_agg import FigureCanvasAgg
+
+
+# XXX heuristic for interactive repl
+if sys.flags.interactive:
+    interactive(True)
+
+
+class FigureManagerSixel(FigureManagerBase):
+    def show(self):
+        try:
+            print("\n   ", end="")
+            p = Popen(
+                ["magick", "-bordercolor", "gray", "png:-", "-border", "2", "sixel:-"],
+                stdin=PIPE,
+            )
+            self.canvas.figure.savefig(p.stdin, bbox_inches="tight", format="png")
+            p.stdin.close()
+            p.wait()
+        except FileNotFoundError:
+            warnings.warn(
+                "Unable to convert plot to sixel format: Imagemagick not found."
+            )
+
+
+class FigureCanvasSixel(FigureCanvasAgg):
+    manager_class = FigureManagerSixel
+
+
+@_Backend.export
+class _BackendSixelAgg(_Backend):
+    FigureCanvas = FigureCanvasSixel
+    FigureManager = FigureManagerSixel
+
+    # Noop function instead of None signals that
+    # this is an "interactive" backend
+    mainloop = lambda: None
+
+    # XXX: `draw_if_interactive` isn't really intended for
+    # on-shot rendering. We run the risk of being called
+    # on a figure that isn't completely rendered yet, so
+    # we skip draw calls for figures that we detect as
+    # not being fully initialized yet. Our heuristic for
+    # that is the presence of axes on the figure.
+    @classmethod
+    def draw_if_interactive(cls):
+        manager = Gcf.get_active()
+        if is_interactive() and manager.canvas.figure.get_axes():
+            cls.show()
+
+    @classmethod
+    def show(cls, *args, **kwargs):
+        _Backend.show(*args, **kwargs)
+        Gcf.destroy_all()
+
+
+def show(*, block=None):
+    """
+    Show all open figures and then close them.
+
+    This matches the behavior of IPython's inline backend, where figures
+    are closed after being displayed to prevent accumulating stale figures
+    from previous plot() calls.
+
+    Parameters
+    ----------
+    block : bool, optional
+        This parameter is ignored for this non-GUI backend.
+    """
+    managers = Gcf.get_all_fig_managers()
+    for manager in managers:
+        manager.show()
+    if managers:
+        Gcf.destroy_all()
+
+
+FigureCanvas = FigureCanvasSixel
+FigureManager = FigureManagerSixel

mplsixel-1.0.0/mplsixel.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: mplsixel
+Version: 1.0.0
+Summary: show matplotlib plots directly in your sixel-enabled terminal
+Project-URL: Homepage, https://codeberg.org/paulw/mplsixel
+Project-URL: Bug Tracker, https://codeberg.org/paulw/mplsixel/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: Framework :: Matplotlib
+Classifier: Topic :: Terminals
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+# matplotlib-backend-sixel
+
+A fork of [matplotlib-backend-sixel](https://github.com/ctorney/matplotlib-backend-sixel)
+
+This python module allows you to use your
+[sixel-enabled terminal](https://www.arewesixelyet.com/)
+to show inline plots generated by python's
+[matplotlib](https://github.com/matplotlib/matplotlib).
+
+The module is a modified version of the [kitty backend](https://github.com/jktr/matplotlib-backend-kitty) and is also based on this 
+earlier [sixel backend](https://github.com/jonathf/matplotlib-sixel).
+
+You will need a terminal that has support for the SIXEL graphics format and [imagemagick](https://imagemagick.org/index.php) installed. 
+
+To install either run
+
+ - `$ pip install --user mplsixel`
+
+or clone this repo and run
+ - `$ cd mplsixel && pip install . `
+
+Configure matplotlib to use the module by either setting the
+environment variable `MPLBACKEND` to `module://matplotlib-backend-sixel`
+or by initializing matplotlib as follows.
+
+```python
+import matplotlib
+matplotlib.use('module://mplsixel')
+import matplotlib.pyplot as plt
+```
+
+You can also use the 
+```python
+%matplotlib sixel```
+line magic to switch to mplsixel backend in e.g. ipython consoles.
+
+If you've installed this module correctly, you can now use
+the following sample code to draw a plot in your terminal.
+
+```
+$ ipython
+In [1]: import matplotlib
+   ...: matplotlib.use('module://mplsixel')
+   ...: import numpy as np
+   ...: import matplotlib.pyplot as plt
+   ...: plt.style.use("dark_background")
+   ...: t = np.linspace(0,5,200)
+   ...: plt.fill_between(t,np.sin(t),np.cos(2*t),alpha=0.5)
+   ...: plt.fill_between(t,np.cos(t),np.sin(2*t),alpha=0.5)
+   ...: plt.show()
+
+<plot is shown>
+```
+
+Example output using Gnome terminal [compiled with SIXEL support](https://github.com/mate-desktop/mate-terminal/issues/410)
+
+![Example output](resources/demo.png)
+
+If you set your matplotlib to interactive mode via
+`matplotlib.pyplot.ion()` or by running python as
+`python -i`, non-empty figures are drawn on construction
+where possible. This allows you to use pandas' `plot()`
+calls directly, without calling `plt.show()`, and still
+enables you to manually construct and `plt.show()`.
+
+If your matplotlib is in non-interactive mode,
+you can construct your figures as usual, and then call
+`plt.show()` to render them to your terminal. This
+works from both a repl and when running scripts.
+
+Internally, this backend is somewhat based on matplotlib's
+IPython support: it's a hybrid of image and GUI backend types.
+It works by using matplotlib's `Agg` backend to render the
+plot, and then calls `imagemagick` to convert to sixel format 
+and then cat the image to your terminal. This means that plotting works as
+expected, but the image drawn to your terminal isn't
+interactive and animations aren't supported.

mplsixel-1.0.0/mplsixel.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+mplsixel/__init__.py
+mplsixel/backend.py
+mplsixel.egg-info/PKG-INFO
+mplsixel.egg-info/SOURCES.txt
+mplsixel.egg-info/dependency_links.txt
+mplsixel.egg-info/entry_points.txt
+mplsixel.egg-info/requires.txt
+mplsixel.egg-info/top_level.txt

mplsixel-1.0.0/mplsixel.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mplsixel-1.0.0/mplsixel.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[matplotlib.backend]
+sixel = mplsixel.backend

mplsixel-1.0.0/mplsixel.egg-info/requires.txt

@@ -0,0 +1 @@
+matplotlib

mplsixel-1.0.0/mplsixel.egg-info/top_level.txt

@@ -0,0 +1 @@
+mplsixel

mplsixel-1.0.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "mplsixel"
+version = "1.0.0"
+description = "show matplotlib plots directly in your sixel-enabled terminal"
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
+    "Framework :: Matplotlib",
+    "Topic :: Terminals",
+]
+
+dependencies = [ "matplotlib" ]
+
+[project.urls]
+"Homepage" = "https://codeberg.org/paulw/mplsixel"
+"Bug Tracker" = "https://codeberg.org/paulw/mplsixel/issues"
+
+[build-system]
+requires = [ "setuptools>=61.0" ]
+build-backend = "setuptools.build_meta"
+
+[project.entry-points."matplotlib.backend"]
+sixel = "mplsixel.backend"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["mplsixel"]

mplsixel-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+