Initial commit

Author: jtcbrule

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Joshua Brule
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,2 @@
+# oscplotlib
+

oscplotlib/__init__.py

@@ -0,0 +1 @@
+from .osc1337 import show, show_all

oscplotlib/osc1337.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+import base64
+import io
+import matplotlib.pyplot as plt
+
+IMG_STRING = "\n\033]1337;File=inline=1;preserveAspectRatio=1:{}\a\n"
+
+class OSC1337:
+    """
+    Wrapper class for OSC 1337 images
+
+    OSC1337 objects display (__repr__) as images, but are implemented as
+    a thin wrapper around a base64 encoded png.
+    """
+    def __init__(self, b64str):
+        self.b64str = b64str
+
+    def __repr__(self):
+        return IMG_STRING.format(self.b64str)
+
+    def savefig(self, fname):
+        """Save the current OSC1337 object"""
+        with open(fname, "wb") as f:
+            f.write(base64.decodebytes(self.b64str.encode()))
+
+
+def show():
+    """
+    Returns an OSC1337 object wrapping the render of figure or of the
+    currently active figure, if figure is None.
+    """
+    figure = plt.gcf()
+
+    buf = io.BytesIO()
+    figure.savefig(buf, format='png')
+    s = base64.b64encode(buf.getvalue()).decode()
+    buf.close()
+
+    return OSC1337(s)
+
+
+def show_all():
+    """
+    Return a list of all active figures as OSC1337 objects
+    """
+    old_fignum = plt.gcf().number
+
+    l = []
+    for i in plt.get_fignums():
+        plt.figure(i)
+        l.append(show())
+
+    plt.figure(old_fignum)
+
+    return l
+