maxplotlibx 0.1.4__tar.gz → 0.1.6__tar.gz

maxplotlibx-0.1.6/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: maxplotlibx
+Version: 0.1.6
+Summary: A reproducible plotting module with various backends and export options.
+Author: Max
+Project-URL: Source, https://github.com/max-models/maxplotlib
+Keywords: matplotlib
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: pint
+Requires-Dist: plotly
+Requires-Dist: plotext
+Requires-Dist: tikzfigure[vis]>=0.3.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Provides-Extra: docs
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: nbconvert; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: maxplotlibx[docs,test]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black[jupyter]; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: nbstripout; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyproject-fmt; extra == "dev"
+Dynamic: license-file
+
+# Maxplotlib
+
+A clean, expressive wrapper around **Matplotlib**, **Plotly**,
+**plotext**, and **tikzfigure** for producing publication-quality
+figures with minimal boilerplate. Swap backends without rewriting your
+data — render the same canvas as a crisp PNG, an interactive Plotly
+chart, a terminal-native plotext figure, or camera-ready **TikZ** code
+for LaTeX.
+
+## Install
+
+``` bash
+pip install maxplotlibx
+```
+
+## Showcase
+
+### Quickstart
+
+``` python
+import numpy as np
+from maxplotlib import Canvas
+
+x = np.linspace(0, 2 * np.pi, 200)
+y = np.sin(x)
+
+canvas, ax = Canvas.subplots()
+ax.plot(x, y)
+```
+
+Plot the figure with the default (matplotlib) backend:
+
+``` python
+canvas.show()
+```
+
+![](README_files/figure-markdown_strict/cell-3-output-1.png)
+
+Render the same line graph directly in the terminal with the `plotext`
+backend:
+
+``` python
+terminal_fig = canvas.plot(backend="plotext")
+print(terminal_fig.build(keep_colors=False))
+```
+
+Or plot with the TikZ backend:
+
+``` python
+canvas.show(backend="tikzfigure")
+```
+
+![](README_files/figure-markdown_strict/cell-4-output-1.png)
+
+### Terminal backend
+
+The `plotext` backend is designed for terminal-first workflows. It
+currently supports line plots, scatter plots, bars, filled regions,
+error bars, reference lines, text/annotations, labels/titles, log
+axes, layers, matrix-style `imshow()` rendering, common patches, and
+multi-subplot canvases.
+
+``` python
+x = np.linspace(1, 10, 40)
+
+canvas, ax = Canvas.subplots()
+ax.plot(x, np.sqrt(x), color="cyan", label="sqrt(x)")
+ax.errorbar(x[::8], np.sqrt(x[::8]), yerr=0.15, color="yellow", label="samples")
+ax.set_title("Terminal plot")
+ax.set_xlabel("x")
+ax.set_ylabel("y")
+ax.set_xscale("log")
+ax.set_legend(True)
+
+canvas.show(backend="plotext")
+```
+
+## Examples
+
+Runnable example scripts live in `examples/`:
+
+``` bash
+python examples/plotly_backend_basic.py
+python examples/plotly_backend_parity.py
+```
+
+### Layers
+
+``` python
+x = np.linspace(0, 2 * np.pi, 200)
+
+canvas, ax = Canvas.subplots(width="10cm", ratio=0.55)
+
+ax.plot(x, np.sin(x), color="steelblue", label=r"$\sin(x)$", layer=0)
+ax.plot(x, np.cos(x), color="tomato", label=r"$\cos(x)$", layer=1)
+ax.plot(
+    x,
+    np.sin(x) * np.cos(x),
+    color="seagreen",
+    label=r"$\sin(x)\cos(x)$",
+    linestyle="dashed",
+    layer=2,
+)
+
+ax.set_xlabel("x")
+ax.set_legend(True)
+```
+
+Show layer 0 only, then layers 0 and 1, then everything:
+
+``` python
+canvas.show(layers=[0])
+```
+
+![](README_files/figure-markdown_strict/cell-6-output-1.png)
+
+Show all layers:
+
+``` python
+canvas.show()
+```
+
+![](README_files/figure-markdown_strict/cell-7-output-1.png)

maxplotlibx-0.1.6/README.md

@@ -0,0 +1,123 @@
+# Maxplotlib
+
+A clean, expressive wrapper around **Matplotlib**, **Plotly**,
+**plotext**, and **tikzfigure** for producing publication-quality
+figures with minimal boilerplate. Swap backends without rewriting your
+data — render the same canvas as a crisp PNG, an interactive Plotly
+chart, a terminal-native plotext figure, or camera-ready **TikZ** code
+for LaTeX.
+
+## Install
+
+``` bash
+pip install maxplotlibx
+```
+
+## Showcase
+
+### Quickstart
+
+``` python
+import numpy as np
+from maxplotlib import Canvas
+
+x = np.linspace(0, 2 * np.pi, 200)
+y = np.sin(x)
+
+canvas, ax = Canvas.subplots()
+ax.plot(x, y)
+```
+
+Plot the figure with the default (matplotlib) backend:
+
+``` python
+canvas.show()
+```
+
+![](README_files/figure-markdown_strict/cell-3-output-1.png)
+
+Render the same line graph directly in the terminal with the `plotext`
+backend:
+
+``` python
+terminal_fig = canvas.plot(backend="plotext")
+print(terminal_fig.build(keep_colors=False))
+```
+
+Or plot with the TikZ backend:
+
+``` python
+canvas.show(backend="tikzfigure")
+```
+
+![](README_files/figure-markdown_strict/cell-4-output-1.png)
+
+### Terminal backend
+
+The `plotext` backend is designed for terminal-first workflows. It
+currently supports line plots, scatter plots, bars, filled regions,
+error bars, reference lines, text/annotations, labels/titles, log
+axes, layers, matrix-style `imshow()` rendering, common patches, and
+multi-subplot canvases.
+
+``` python
+x = np.linspace(1, 10, 40)
+
+canvas, ax = Canvas.subplots()
+ax.plot(x, np.sqrt(x), color="cyan", label="sqrt(x)")
+ax.errorbar(x[::8], np.sqrt(x[::8]), yerr=0.15, color="yellow", label="samples")
+ax.set_title("Terminal plot")
+ax.set_xlabel("x")
+ax.set_ylabel("y")
+ax.set_xscale("log")
+ax.set_legend(True)
+
+canvas.show(backend="plotext")
+```
+
+## Examples
+
+Runnable example scripts live in `examples/`:
+
+``` bash
+python examples/plotly_backend_basic.py
+python examples/plotly_backend_parity.py
+```
+
+### Layers
+
+``` python
+x = np.linspace(0, 2 * np.pi, 200)
+
+canvas, ax = Canvas.subplots(width="10cm", ratio=0.55)
+
+ax.plot(x, np.sin(x), color="steelblue", label=r"$\sin(x)$", layer=0)
+ax.plot(x, np.cos(x), color="tomato", label=r"$\cos(x)$", layer=1)
+ax.plot(
+    x,
+    np.sin(x) * np.cos(x),
+    color="seagreen",
+    label=r"$\sin(x)\cos(x)$",
+    linestyle="dashed",
+    layer=2,
+)
+
+ax.set_xlabel("x")
+ax.set_legend(True)
+```
+
+Show layer 0 only, then layers 0 and 1, then everything:
+
+``` python
+canvas.show(layers=[0])
+```
+
+![](README_files/figure-markdown_strict/cell-6-output-1.png)
+
+Show all layers:
+
+``` python
+canvas.show()
+```
+
+![](README_files/figure-markdown_strict/cell-7-output-1.png)

{maxplotlibx-0.1.4 → maxplotlibx-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maxplotlibx"
-version = "0.1.4"
+version = "0.1.6"
 description = "A reproducible plotting module with various backends and export options."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -18,7 +18,8 @@ dependencies = [
     "matplotlib",
     "pint",
     "plotly",
-    "tikzfigure[vis]>=0.2.0",
+    "plotext",
+    "tikzfigure[vis]>=0.3.0",
 ]
 [project.optional-dependencies]
 test = [

maxplotlibx-0.1.6/src/maxplotlib/__init__.py

@@ -0,0 +1,3 @@
+from maxplotlib.canvas.canvas import Canvas, SubplotSpacing
+
+__all__ = ["Canvas", "SubplotSpacing"]

{maxplotlibx-0.1.4 → maxplotlibx-0.1.6}/src/maxplotlib/backends/matplotlib/utils.py

@@ -6,7 +6,7 @@ import matplotlib.pyplot as plt
 import pint
 
 
-def setup_tex_fonts(fontsize=14, usetex=False):
+def setup_tex_fonts(fontsize=10, usetex=False):
     """
     Sets up LaTeX fonts for plotting.
     """
@@ -15,6 +15,8 @@ def setup_tex_fonts(fontsize=14, usetex=False):
         "font.family": "serif",
         "pgf.rcfonts": False,
         "axes.labelsize": fontsize,
+        "axes.titlesize": fontsize,
+        "figure.titlesize": fontsize,
         "font.size": fontsize,
         "legend.fontsize": fontsize,
         "xtick.labelsize": fontsize,
@@ -58,13 +60,13 @@ def convert_to_inches(length_str):
 
 def _2pt(width, dpi=300, verbose: bool = False):
     if verbose:
-        print(f"Converting width: {width} to points with dpi={dpi}")
+        print(f"Converting width: {width} to points")
 
     if isinstance(width, (int, float)):
         return width
     elif isinstance(width, str):
         length_in = convert_to_inches(width)
-        length_pt = length_in * dpi
+        length_pt = length_in * 72.27
         if verbose:
             print(f"Converted length: {length_in} inches = {length_pt} points")
         return length_pt

maxplotlibx-0.1.6/src/maxplotlib/backends/plotext/__init__.py

@@ -0,0 +1,3 @@
+from maxplotlib.backends.plotext.figure import PlotextFigure, create_plotext_figure
+
+__all__ = ["PlotextFigure", "create_plotext_figure"]

maxplotlibx-0.1.6/src/maxplotlib/backends/plotext/figure.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+from plotext._figure import _figure_class
+
+_ANSI_ESCAPE_RE = re.compile(r"\x1B\[[0-?]*[ -/]*[@-~]")
+
+
+def strip_ansi(text: str) -> str:
+    return _ANSI_ESCAPE_RE.sub("", text)
+
+
+def create_plotext_figure(nrows: int = 1, ncols: int = 1) -> _figure_class:
+    figure = _figure_class()
+    if nrows > 1 or ncols > 1:
+        figure.subplots(nrows, ncols)
+    return figure
+
+
+class PlotextFigure:
+    def __init__(self, figure: _figure_class, suptitle: str | None = None):
+        self.figure = figure
+        self.suptitle = suptitle
+
+    def build(self, keep_colors: bool = True) -> str:
+        output = self.figure.build()
+        if self.suptitle:
+            output = f"{self.suptitle}\n{output}"
+        return output if keep_colors else strip_ansi(output)
+
+    def show(self) -> str:
+        output = self.build()
+        print(output)
+        return output
+
+    def savefig(self, path, append: bool = False, keep_colors: bool = False) -> None:
+        destination = Path(path)
+        mode = "a" if append else "w"
+        with destination.open(mode, encoding="utf-8") as handle:
+            handle.write(self.build(keep_colors=keep_colors))
+            handle.write("\n")
+
+    save_fig = savefig
+
+    def __getattr__(self, name):
+        return getattr(self.figure, name)
+
+    def __str__(self) -> str:
+        return self.build(keep_colors=False)