plotis 0.1.9__tar.gz → 0.2.1__tar.gz

{plotis-0.1.9 → plotis-0.2.1}/.github/workflows/publish_prod.yml

@@ -30,7 +30,7 @@ jobs:
       run: python3 -m build
     
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -50,7 +50,7 @@ jobs:
     
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -71,13 +71,20 @@ jobs:
       id-token: write  # IMPORTANT: mandatory for sigstore
 
     steps:
+    - uses: actions/checkout@v4
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
+    - name: Extract release notes from CHANGELOG.md
+      # Prints the section between "## [<version>]" and the next "## [" heading
+      run: >-
+        awk -v v="${GITHUB_REF_NAME#v}"
+        '/^## \[/ { p = index($0, "## [" v "]") == 1; next } p'
+        CHANGELOG.md > release-notes.md
     - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
       with:
         inputs: >-
           ./dist/*.tar.gz
@@ -89,7 +96,7 @@ jobs:
         gh release create
         '${{ github.ref_name }}'
         --repo '${{ github.repository }}'
-        --notes ""
+        --notes-file release-notes.md
     - name: Upload artifact signatures to GitHub Release
       env:
         GITHUB_TOKEN: ${{ github.token }}

{plotis-0.1.9 → plotis-0.2.1}/.github/workflows/publish_test.yml

@@ -30,7 +30,7 @@ jobs:
       run: python3 -m build
     
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -50,7 +50,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -58,3 +58,5 @@ jobs:
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         repository-url: https://test.pypi.org/legacy/
+        # Pushes to main that don't bump the version must not fail
+        skip-existing: true

plotis-0.2.1/.github/workflows/tests.yml

@@ -0,0 +1,55 @@
+# Installs the package with its dev extras, lints, runs the tests and the
+# ex2 example on every supported Python version.
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Test workflow
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: tests (${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install package with dev extras
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=.venv
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude=.venv
+    - name: Test with pytest
+      run: pytest
+    - name: Run the ex2 example and reproduce its figures (no LaTeX)
+      run: make -C examples/ex2 reproduce
+
+  # Single check named "test" that branch protection on main requires.
+  # It passes only if every Python version in the matrix passed, so the
+  # matrix can change without updating the protection rule.
+  test:
+    needs: tests
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check that all matrix jobs passed
+      run: test "${{ needs.tests.result }}" = "success"

{plotis-0.1.9 → plotis-0.2.1}/.gitignore

@@ -468,3 +468,10 @@ TSWLatexianTemp*
 
 # glossaries
 *.glstex
+
+### plotis examples ###
+# Built from source by the example Makefiles
+examples/*/main.pdf
+examples/*/figures/
+examples/*/moved/
+examples/ex1/sinus_curve/

plotis-0.2.1/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [0.2.1]
+
+### Fixed
+- Release workflow: the Sigstore signing action is bumped to v3, since v2
+  relied on the shut-down `upload-artifact@v3`. The 0.2.0 GitHub release
+  failed because of this, so 0.2.1 replaces it. The package code is the
+  same as in 0.2.0.
+- TestPyPI publishing on pushes to `main` skips versions that are already
+  uploaded instead of failing.
+
+## [0.2.0]
+
+### Added
+- `format`, `savefig_kwargs`, `style` and `render` arguments to `PlotIs`.
+- `PlotIsError`, raised when a context cannot be isolated.
+- `plotis.__version__`.
+- `examples/ex2`: every option, a LaTeX document and a `make reproduce` target.
+
+### Changed
+- The `with` statement is located by parsing the calling file with `ast`
+  instead of regexes and line counting. Multi-line `with` statements,
+  keyword arguments in any order, one-line bodies and nested blocks work.
+- `run.py` resolves `data.csv`, the style file and the figure relative to
+  itself, so the folder can be moved and run from any working directory.
+- The data is captured when the context is entered, so changes the body makes
+  to the data frame are not saved to `data.csv` (and applied twice by `run.py`).
+- `savefig()`/`show()` statements are replaced by `pass` in `run.py`.
+- `data.csv` is written without the index column.
+- Nothing is written if the context raises an exception.
+- `numpy` is no longer a runtime dependency.
+
+### Breaking
+- Python 3.9 is no longer supported (end-of-life); 3.10 or newer is required.
+- Errors are raised as `PlotIsError` (or `TypeError`/`FileNotFoundError` for
+  invalid arguments) instead of a generic `Exception`.
+- `data` must be passed as a plain variable name.
+- `data.csv` has no index column: read it with `pd.read_csv(path)` and
+  without `index_col=0`.
+- `run.py` saves `figure.<format>` next to itself. In 0.1 the path was
+  `<figpath>/figure.png` relative to the working directory, so `run.py`
+  only worked when run from the same directory as the original script.
+
+## [0.1.9]
+- Last release of the regex-based implementation.

plotis-0.2.1/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: plotis
+Version: 0.2.1
+Summary: Plot isolation tool for python
+Project-URL: Homepage, https://github.com/victorbrun/plotis
+Project-URL: Issues, https://github.com/victorbrun/plotis/issues
+Author-email: Victor Brun <me@victorbrun.com>
+License-File: LICENCE
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Provides-Extra: dev
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: numpy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# `plotis`
+`plotis` is a plot isolation tool for Python. It saves the data and Python code needed to reproduce a plot independently, using a pythonic interface.
+
+This project started as a fix for repositories that balloon in size in documentation projects where images are updated often. The most common image formats are not plain text, so Git cannot version them efficiently and stores every version of every image. Instead of converting images to a plain-text format or pruning the Git history, I chose to overengineer this solution: a Python context manager extracts the code and data needed to reproduce each plot.
+
+# Installation
+```bash
+pip install plotis
+```
+
+# Usage
+## Simple example
+`plotis` relies on the context manager `PlotIs`. Put the plotting logic inside a `PlotIs` context and pass it the data used for plotting, as shown below. On exit, `PlotIs` creates a folder containing the data (`<figfoldername>/data.csv`) and code (`<figfoldername>/run.py`) needed to reproduce the plot independently.
+```python
+import numpy as np
+import pandas as pd
+import matplotlib.pyplot as plt
+
+from plotis import PlotIs
+
+# Generates sample data
+x = np.linspace(0, 4 * np.pi)
+sample_data = pd.DataFrame({"x": x, "y": np.sin(x)})
+
+# Creates the plot inside a PlotIs context. The folder fig1 will contain
+# the code and data needed to reproduce the plot independently.
+with PlotIs("fig1", sample_data):
+    sample_data.plot(x="x", y="y")
+    plt.title("Sine function")
+    plt.xlabel("x")
+    plt.ylabel("sin(x)")
+
+    # Shows the plot here; replaced by `pass` in run.py
+    plt.show()
+```
+
+Running `python fig1/run.py`, from any directory, writes `fig1/figure.png`.
+
+## Options
+```python
+with PlotIs(
+    "figures/sine",           # folder for data.csv, run.py (and the figure)
+    sample_data,              # must be a plain variable name
+    format="pdf",             # any format plt.savefig understands (default "png")
+    savefig_kwargs={"bbox_inches": "tight"},  # literals only
+    style="house.mplstyle",   # applied in the context, copied next to run.py
+    render=True,              # also write figures/sine/figure.pdf on exit
+):
+    fig, ax = plt.subplots()
+    for name, group in sample_data.groupby("series"):  # nested blocks are fine
+        ax.plot(group["x"], group["y"], label=name)
+    ax.legend()
+```
+
+- `run.py` resolves `data.csv`, the style file and the output figure relative to its own location, so the folder can be moved and the script run from any working directory.
+- The `with` statement is parsed with `ast`: it may span several lines, use keyword arguments in any order, or put the body on the same line.
+- The data is captured when the context is entered, so changes the body makes to the data frame are not saved (and are not applied twice by `run.py`).
+- `data.csv` is written without the index column.
+- Nothing is written if the context raises an exception.
+- `savefig()`/`show()` statements in the context are replaced by `pass` in `run.py`.
+
+`examples/ex2` uses every option above. Run `make` there to build the figures and a LaTeX document, and `make reproduce` to regenerate the figures from the moved `run.py` files alone.
+
+## Limitations
+`run.py` contains only the body of the `with` block, preceded by `import pandas as pd`, `import matplotlib.pyplot as plt` and the data variable loaded from `data.csv`. So the body:
+
+- may only use `pd`, `plt`, the data variable and names it defines or imports itself. Other names from the surrounding script, such as `np`, helper functions or other variables, do not exist in `run.py`.
+- must produce a single figure, with at most one `savefig()` and one `show()` call.
+- cannot contain another `PlotIs` context.
+
+With `render=True`, a `plt.show()` in the body can close the figure on interactive backends, which leaves the rendered file empty. Use `render=True` without `show()`, or use a non-interactive backend such as `Agg`.
+
+`PlotIs` must be used in a source file (not an interactive prompt or notebook cell), since it reads the `with` block from the calling file.
+
+## Errors
+| Exception | Raised when |
+|---|---|
+| `PlotIsError` | `PlotIs` is not used as a `with` statement, `data` is not a plain variable name, the body nests `PlotIs` or has more than one `savefig()`/`show()` call, `savefig_kwargs` holds non-literal values, or the calling source file cannot be read. |
+| `TypeError` | `data` is not a `pandas.DataFrame`. |
+| `FileNotFoundError` | The `style` file does not exist. |
+
+## Migrating from 0.1
+- Python 3.10 or newer is required.
+- Catch `PlotIsError` instead of `Exception`.
+- Pass `data` as a plain variable name (`PlotIs(path, df)`, not `PlotIs(path, df.copy())`).
+- `data.csv` has no index column. Read it with `pd.read_csv(path)`, without `index_col=0`.
+- `run.py` now saves `figure.<format>` next to itself instead of relative to the working directory.
+
+See [CHANGELOG.md](CHANGELOG.md) for the full list of changes.
+
+## LaTeX project example
+Since this package was motivated by large documentation projects, this example shows how to hook into the compilation of a LaTeX document to insert the figure produced by the example above.
+
+Consider a LaTeX document with the following content:
+```latex
+\documentclass[12pt]{article}
+\usepackage{graphicx}
+\usepackage{hyperref}
+
+\title{PlotIs example one}
+\author{Victor Brun\\ \href{https://victorbrun.com}{victorbrun.com}}
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\section{The sine function}
+The sine function is a trigonometric function which we denote by $\sin{x}$. In figure \ref{fig:sin} we can see that it looks like a wave.
+
+\begin{figure}[h]
+	\centering
+	\includegraphics[width=8cm]{figures/sinus_curve.png}
+	\caption{The sine function plotted on the interval $[0, 4\pi]$.}
+	\label{fig:sin}
+\end{figure}
+
+\end{document}
+```
+
+To keep the repository small, `figures/sinus_curve.png` is not committed, since it is not a plain-text format. The plotting script (`plot_script.py`, using `PlotIs` as above) writes `sinus_curve/data.csv` and `sinus_curve/run.py`, which are enough to recreate the figure. A Makefile then runs `run.py`, copies the image to where the LaTeX document expects it and compiles the document:
+```make
+PYTHON ?= python3
+FIG := sinus_curve
+
+all: main.pdf
+
+# Runs the plotting script, which writes the isolated data and code
+$(FIG)/run.py $(FIG)/data.csv: plot_script.py
+	$(PYTHON) plot_script.py
+
+# Runs the automatically generated python script to create the plot
+$(FIG)/figure.png: $(FIG)/run.py $(FIG)/data.csv
+	$(PYTHON) $(FIG)/run.py
+
+# Copies the produced figure to where main.tex expects it
+figures/$(FIG).png: $(FIG)/figure.png
+	mkdir -p figures
+	cp $< $@
+
+# Runs pdflatex twice so that references are resolved
+main.pdf: main.tex figures/$(FIG).png
+	pdflatex main.tex
+	pdflatex main.tex
+```
+
+In a real project you would commit `sinus_curve/` and run only the last three rules. The working example is in `examples/ex1`.
+
+# Development
+```bash
+pip install -e ".[dev]"
+pytest
+```

plotis-0.2.1/README.md

@@ -0,0 +1,153 @@
+# `plotis`
+`plotis` is a plot isolation tool for Python. It saves the data and Python code needed to reproduce a plot independently, using a pythonic interface.
+
+This project started as a fix for repositories that balloon in size in documentation projects where images are updated often. The most common image formats are not plain text, so Git cannot version them efficiently and stores every version of every image. Instead of converting images to a plain-text format or pruning the Git history, I chose to overengineer this solution: a Python context manager extracts the code and data needed to reproduce each plot.
+
+# Installation
+```bash
+pip install plotis
+```
+
+# Usage
+## Simple example
+`plotis` relies on the context manager `PlotIs`. Put the plotting logic inside a `PlotIs` context and pass it the data used for plotting, as shown below. On exit, `PlotIs` creates a folder containing the data (`<figfoldername>/data.csv`) and code (`<figfoldername>/run.py`) needed to reproduce the plot independently.
+```python
+import numpy as np
+import pandas as pd
+import matplotlib.pyplot as plt
+
+from plotis import PlotIs
+
+# Generates sample data
+x = np.linspace(0, 4 * np.pi)
+sample_data = pd.DataFrame({"x": x, "y": np.sin(x)})
+
+# Creates the plot inside a PlotIs context. The folder fig1 will contain
+# the code and data needed to reproduce the plot independently.
+with PlotIs("fig1", sample_data):
+    sample_data.plot(x="x", y="y")
+    plt.title("Sine function")
+    plt.xlabel("x")
+    plt.ylabel("sin(x)")
+
+    # Shows the plot here; replaced by `pass` in run.py
+    plt.show()
+```
+
+Running `python fig1/run.py`, from any directory, writes `fig1/figure.png`.
+
+## Options
+```python
+with PlotIs(
+    "figures/sine",           # folder for data.csv, run.py (and the figure)
+    sample_data,              # must be a plain variable name
+    format="pdf",             # any format plt.savefig understands (default "png")
+    savefig_kwargs={"bbox_inches": "tight"},  # literals only
+    style="house.mplstyle",   # applied in the context, copied next to run.py
+    render=True,              # also write figures/sine/figure.pdf on exit
+):
+    fig, ax = plt.subplots()
+    for name, group in sample_data.groupby("series"):  # nested blocks are fine
+        ax.plot(group["x"], group["y"], label=name)
+    ax.legend()
+```
+
+- `run.py` resolves `data.csv`, the style file and the output figure relative to its own location, so the folder can be moved and the script run from any working directory.
+- The `with` statement is parsed with `ast`: it may span several lines, use keyword arguments in any order, or put the body on the same line.
+- The data is captured when the context is entered, so changes the body makes to the data frame are not saved (and are not applied twice by `run.py`).
+- `data.csv` is written without the index column.
+- Nothing is written if the context raises an exception.
+- `savefig()`/`show()` statements in the context are replaced by `pass` in `run.py`.
+
+`examples/ex2` uses every option above. Run `make` there to build the figures and a LaTeX document, and `make reproduce` to regenerate the figures from the moved `run.py` files alone.
+
+## Limitations
+`run.py` contains only the body of the `with` block, preceded by `import pandas as pd`, `import matplotlib.pyplot as plt` and the data variable loaded from `data.csv`. So the body:
+
+- may only use `pd`, `plt`, the data variable and names it defines or imports itself. Other names from the surrounding script, such as `np`, helper functions or other variables, do not exist in `run.py`.
+- must produce a single figure, with at most one `savefig()` and one `show()` call.
+- cannot contain another `PlotIs` context.
+
+With `render=True`, a `plt.show()` in the body can close the figure on interactive backends, which leaves the rendered file empty. Use `render=True` without `show()`, or use a non-interactive backend such as `Agg`.
+
+`PlotIs` must be used in a source file (not an interactive prompt or notebook cell), since it reads the `with` block from the calling file.
+
+## Errors
+| Exception | Raised when |
+|---|---|
+| `PlotIsError` | `PlotIs` is not used as a `with` statement, `data` is not a plain variable name, the body nests `PlotIs` or has more than one `savefig()`/`show()` call, `savefig_kwargs` holds non-literal values, or the calling source file cannot be read. |
+| `TypeError` | `data` is not a `pandas.DataFrame`. |
+| `FileNotFoundError` | The `style` file does not exist. |
+
+## Migrating from 0.1
+- Python 3.10 or newer is required.
+- Catch `PlotIsError` instead of `Exception`.
+- Pass `data` as a plain variable name (`PlotIs(path, df)`, not `PlotIs(path, df.copy())`).
+- `data.csv` has no index column. Read it with `pd.read_csv(path)`, without `index_col=0`.
+- `run.py` now saves `figure.<format>` next to itself instead of relative to the working directory.
+
+See [CHANGELOG.md](CHANGELOG.md) for the full list of changes.
+
+## LaTeX project example
+Since this package was motivated by large documentation projects, this example shows how to hook into the compilation of a LaTeX document to insert the figure produced by the example above.
+
+Consider a LaTeX document with the following content:
+```latex
+\documentclass[12pt]{article}
+\usepackage{graphicx}
+\usepackage{hyperref}
+
+\title{PlotIs example one}
+\author{Victor Brun\\ \href{https://victorbrun.com}{victorbrun.com}}
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\section{The sine function}
+The sine function is a trigonometric function which we denote by $\sin{x}$. In figure \ref{fig:sin} we can see that it looks like a wave.
+
+\begin{figure}[h]
+	\centering
+	\includegraphics[width=8cm]{figures/sinus_curve.png}
+	\caption{The sine function plotted on the interval $[0, 4\pi]$.}
+	\label{fig:sin}
+\end{figure}
+
+\end{document}
+```
+
+To keep the repository small, `figures/sinus_curve.png` is not committed, since it is not a plain-text format. The plotting script (`plot_script.py`, using `PlotIs` as above) writes `sinus_curve/data.csv` and `sinus_curve/run.py`, which are enough to recreate the figure. A Makefile then runs `run.py`, copies the image to where the LaTeX document expects it and compiles the document:
+```make
+PYTHON ?= python3
+FIG := sinus_curve
+
+all: main.pdf
+
+# Runs the plotting script, which writes the isolated data and code
+$(FIG)/run.py $(FIG)/data.csv: plot_script.py
+	$(PYTHON) plot_script.py
+
+# Runs the automatically generated python script to create the plot
+$(FIG)/figure.png: $(FIG)/run.py $(FIG)/data.csv
+	$(PYTHON) $(FIG)/run.py
+
+# Copies the produced figure to where main.tex expects it
+figures/$(FIG).png: $(FIG)/figure.png
+	mkdir -p figures
+	cp $< $@
+
+# Runs pdflatex twice so that references are resolved
+main.pdf: main.tex figures/$(FIG).png
+	pdflatex main.tex
+	pdflatex main.tex
+```
+
+In a real project you would commit `sinus_curve/` and run only the last three rules. The working example is in `examples/ex1`.
+
+# Development
+```bash
+pip install -e ".[dev]"
+pytest
+```

plotis-0.2.1/examples/ex1/Makefile

@@ -0,0 +1,27 @@
+PYTHON ?= python3
+FIG := sinus_curve
+
+all: main.pdf
+
+# Runs the plotting script, which writes the isolated data and code
+$(FIG)/run.py $(FIG)/data.csv: plot_script.py
+	$(PYTHON) plot_script.py
+
+# Runs the automatically generated python script to create the plot
+$(FIG)/figure.png: $(FIG)/run.py $(FIG)/data.csv
+	$(PYTHON) $(FIG)/run.py
+
+# Copies the produced figure to where main.tex expects it
+figures/$(FIG).png: $(FIG)/figure.png
+	mkdir -p figures
+	cp $< $@
+
+# Runs pdflatex twice so that references are resolved
+main.pdf: main.tex figures/$(FIG).png
+	pdflatex main.tex
+	pdflatex main.tex
+
+clean:
+	rm -rf $(FIG) figures main.aux main.log main.out main.pdf
+
+.PHONY: all clean

plotis-0.2.1/examples/ex1/plot_script.py

@@ -0,0 +1,47 @@
+"""Example showing a simple use case of PlotIs.
+
+Run ``make`` in this folder. It runs this script, which writes
+``sinus_curve/data.csv`` and ``sinus_curve/run.py``, then regenerates the
+figure from ``run.py`` alone and builds ``main.pdf``.
+"""
+
+from pathlib import Path
+
+import matplotlib
+
+matplotlib.use("Agg")
+
+import matplotlib.pyplot as plt  # noqa: E402
+import numpy as np  # noqa: E402
+import pandas as pd  # noqa: E402
+
+from plotis import PlotIs  # noqa: E402
+
+# The figure folder is placed next to this file, whatever the working directory
+FIGURE_FOLDER = Path(__file__).resolve().parent / "sinus_curve"
+
+
+def generate_data() -> pd.DataFrame:
+    """Generate sample data using the sine function."""
+    x = np.linspace(0, 4 * np.pi)
+    return pd.DataFrame({"x": x, "y": np.sin(x)})
+
+
+def run() -> None:
+    sample_data = generate_data()
+
+    # Plot the data frame as usual, but inside the PlotIs context. This saves
+    # sample_data and the code in the context, so that the plot can be
+    # reproduced without any dependency on this file.
+    with PlotIs(FIGURE_FOLDER, sample_data):
+        sample_data.plot(x="x", y="y")
+        plt.title("Sine function")
+        plt.xlabel("x")
+        plt.ylabel("sin(x)")
+
+        # Replaced by `pass` in run.py
+        plt.show()
+
+
+if __name__ == "__main__":
+    run()

plotis-0.2.1/examples/ex2/Makefile

@@ -0,0 +1,24 @@
+PYTHON ?= python3
+
+all: figures main.pdf
+
+# Runs the plotting script: writes figures/*/{data.csv,run.py,house.mplstyle,figure.pdf}
+figures: plot_script.py house.mplstyle
+	$(PYTHON) plot_script.py
+
+main.pdf: main.tex figures
+	pdflatex main.tex
+	pdflatex main.tex
+
+# Shows that run.py is self-contained and relocatable: the figure folders are
+# moved, and each figure is regenerated from run.py + data.csv, run from /
+reproduce: figures
+	rm -rf moved && mkdir moved && cp -R figures/waves figures/bars moved/
+	rm moved/*/figure.pdf
+	cd / && for d in "$(CURDIR)"/moved/*; do $(PYTHON) "$$d/run.py"; done
+	ls moved/*/figure.pdf
+
+clean:
+	rm -rf figures moved main.aux main.log main.out main.pdf
+
+.PHONY: all figures reproduce clean

plotis-0.2.1/examples/ex2/house.mplstyle

@@ -0,0 +1,10 @@
+# Shared house style, applied inside the PlotIs context and copied next to run.py
+figure.figsize: 4.5, 2.8
+font.family: serif
+font.size: 9
+axes.spines.top: False
+axes.spines.right: False
+axes.grid: True
+grid.color: "#e4e3df"
+legend.frameon: False
+axes.prop_cycle: cycler("color", ["2a78d6", "eb6834", "1f9e74"])

plotis-0.2.1/examples/ex2/main.tex

@@ -0,0 +1,32 @@
+\documentclass[11pt]{article}
+\usepackage{graphicx}
+\usepackage{hyperref}
+\usepackage[utf8]{inputenc}
+
+\title{PlotIs example two: every 0.2 option}
+\author{Victor Brun\\ \href{https://victorbrun.com}{victorbrun.com}}
+\date{\today}
+
+\begin{document}
+\maketitle
+
+Both figures below are vector PDFs written by \texttt{PlotIs(..., format="pdf",
+render=True)} and included straight from their figure folders. Nothing is
+copied or moved.
+
+\begin{figure}[h]
+  \centering
+  \includegraphics{figures/waves/figure.pdf}
+  \caption{Three phase-shifted sine waves, drawn with a \texttt{for} loop and
+  an \texttt{if} inside the PlotIs context and styled by \texttt{house.mplstyle}.}
+  \label{fig:waves}
+\end{figure}
+
+\begin{figure}[h]
+  \centering
+  \includegraphics{figures/bars/figure.pdf}
+  \caption{A bar chart with non-ASCII labels.}
+  \label{fig:bars}
+\end{figure}
+
+\end{document}