pyplotdesigner 0.6.0

Design matplotlib figure layouts visually, then reuse them in Python.

PyPI package: https://pypi.org/project/pyplotdesigner/

Documentation: pyplotdesigner on Read the Docs

Quickstart (recommended: PyPI)

1) Install with pip

pip install -U pip
pip install pyplotdesigner

2) Start the GUI

python -m pyplotdesigner.gui.main

This opens your browser automatically. If it does not, open:

• http://127.0.0.1:8080/ui

Optional:

• python -m pyplotdesigner.gui.main --no-browser (disable auto-open)
• python -m pyplotdesigner.gui.main --reload (enable auto-reload for dev)

3) Build a layout in the GUI

1. Click Add Axis.
2. Drag boxes into place.
3. Add constraints (align, match size, aspect ratio, spacing, etc.).
4. Click Quick Copy to copy the code directly to your clipboard or alternatively click Import/Export for access to the layout string.

4) Use the exported layout in Python

# following lines will be automatically copied to your clipboard
from pyplotdesigner.core.design_loader import load_design, make_figure_from_design
import_string = "PASTE_EXPORTED_STRING"
design = load_design(import_string)
fig, axes = make_figure_from_design(design)

# example usage:
# left_panel = axes['left_panel']
# left_panel.plot([0, 1], [0, 1])

To adjust a named constant from the GUI, insert an edit before the final line:

design.get_constant("spacing").value.set(0.4)

Use the name of a constant that exists in your layout. Rendering solves the constraints using its updated value, including dependent subplot spacing.

Import/Export and Quick Copy produce gzip-compressed layout strings with a ppd1: prefix. Compression and decoding happen on the local Python server. The GUI, load_design(), and make_figure_from_b64() accept both these strings and existing uncompressed base64 layouts. Compressed strings require pyplotdesigner 0.6.0 or newer; older installations can still use legacy strings.

For Python exports, design.get_b64_string() retains its legacy format. Use design.get_b64_string(compressed=True) for compressed output.

Figure size and font sizes

Saving with fig.savefig('my_figure.pdf', bbox_inches='tight') automatically expands the saved bounding box to include labels and other content outside the nominal figure boundary, and trims unused outer space. You do not need to fit everything within the figure size chosen in the designer; the axes keep their physical sizes and spacing.

If you need a specific publication width, design at that final size and keep labels within its boundary. Save without tight cropping (matplotlib.rcParams['savefig.bbox'] = None if your settings enable it by default), then place the figure at its original physical size. This lets you choose font sizes directly in points: 10-point text remains 10-point text. Resizing the image afterward scales the text too. See designing layouts for more detail.

If you need to: clone and install locally

git clone git@github.com:gnwong/pyplotdesigner.git
cd pyplotdesigner
pip install -U pip
pip install -e .

Run tests

pip install pytest
pytest

Frontend E2E tests (Playwright)

These tests exercise the real browser UI against the FastAPI app.

Install once:

npm install
npx playwright install chromium

Run E2E suite:

npm run e2e

Useful variants:

npm run e2e:headed
npm run e2e:ui

Documentation

The documentation source is in docs/. Build and check it locally with:

python -m pip install -e .
python -m pip install -r docs/requirements.txt
python -m sphinx -b html -W --keep-going docs docs/_build/html
python -m sphinx -b doctest -W --keep-going docs docs/_build/doctest

Open docs/_build/html/index.html for the guides, worked example, and API reference. See the docs build guide for editing and local build instructions.

Contributing

Contributions are welcome.

Expected workflow:

1. Open an issue (or reference an existing one) describing the change.
2. Create a focused branch and implement the change.
3. Add or update tests for any new feature or behavior change.
4. Run tests locally (pytest) and make sure they pass.
5. Open a PR with a clear summary and testing notes.

Guidelines:

• Keep changes focused and minimal.
• Preserve existing behavior unless your PR intentionally changes it.
• If behavior changes, document it and include regression coverage.

License

MIT (see LICENSE).