Skip to main content

Reusable anywidget plot saver configurable with a config.toml.

Project description

plot-saver

plot-saver is a small reusable package for adding save buttons to Matplotlib figures in marimo notebooks.

It saves plots under a project results directory and can be configured with a project-level config.toml.

Installation

pip install plot-saver

or with uv:

uv add plot-saver

Config

plot-saver looks for a config.toml by searching upward from the current working directory.

All configuration keys are optional. If you do not provide a config.toml, or if you only provide some keys, plot-saver falls back to its built-in defaults.

The default output format is png.

You can override the defaults with a section like this:

[plot-saver]
format = "png"
default_label = "Save"
save_all_label = "Save all model plots"
empty_title = "No plots available"
empty_detail = "Render the notebook plots first."
saved_title = "Saved"
saved_many_title = "Saved {count} plots"
saved_error_title = "Saved with errors"
failed_title = "Could not save plots"
toast_detail_color = "#6b7280"

[plot-saver.theme]
radius = "8px"
padding_y = "0.45rem"
padding_x = "0.9rem"
font_size = "0.9rem"
light_border = "rgba(107, 114, 128, 0.35)"
light_background = "rgba(249, 250, 251, 0.95)"
light_text = "#111827"
light_hover_background = "rgba(243, 244, 246, 1)"
light_hover_border = "rgba(107, 114, 128, 0.55)"
light_disabled_background = "rgba(229, 231, 235, 0.9)"
light_disabled_border = "rgba(156, 163, 175, 0.35)"
dark_border = "rgba(156, 163, 175, 0.35)"
dark_background = "rgba(31, 41, 55, 0.95)"
dark_text = "#f3f4f6"
dark_hover_background = "rgba(55, 65, 81, 1)"
dark_hover_border = "rgba(209, 213, 219, 0.45)"
dark_disabled_background = "rgba(55, 65, 81, 0.8)"
dark_disabled_border = "rgba(107, 114, 128, 0.35)"

Usage

from pathlib import Path

import marimo as mo
import matplotlib.pyplot as plt
from plot_saver import make_plot_saver

fig, ax = plt.subplots()
ax.plot([0, 1, 2], [1, 3, 2])

save_plot = make_plot_saver(
    mo,
    results_dir=Path("results"),
    config_path=None,
    task_name="2AFC",
    model_id="example-model",
)

button = save_plot(fig, "Example figure")
save_all = save_plot.save_all_widget()

Saved plots go to:

results/plots/<task_name>/<model_id>/

save_plot(fig, "Example figure") registers that figure and returns an individual save button for it.

save_plot.save_all_widget() returns a single button that saves every figure previously registered with that PlotSaver instance. This is useful in notebooks where you render several figures for the same task and model and want one action to export all of them together.

API

Main entry points:

  • make_plot_saver(...)
  • save_button(...)
  • save_figure(...)
  • get_plot_save_format(...)
  • find_project_config_path(...)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plot_saver-0.1.6.tar.gz (56.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plot_saver-0.1.6-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file plot_saver-0.1.6.tar.gz.

File metadata

  • Download URL: plot_saver-0.1.6.tar.gz
  • Upload date:
  • Size: 56.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for plot_saver-0.1.6.tar.gz
Algorithm Hash digest
SHA256 ce27bf24959ebbf061586bb470319a9b76e111bad490e76de9946dee139e8f5c
MD5 0f2f721c520c14b983fdcac9f53a5c8d
BLAKE2b-256 a787c329fc727ada5af45e174f5bd42a8ef958af4c72d9000edc2b631ab0e80f

See more details on using hashes here.

Provenance

The following attestation bundles were made for plot_saver-0.1.6.tar.gz:

Publisher: publish.yml on javirm3/plot-saver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plot_saver-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: plot_saver-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for plot_saver-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a62557043b5d067a76482a9c5b4fa812aeadcfdace8d019e7c6293e85fcbcb98
MD5 99e0b6f24fc3cbca52d45261ee124e76
BLAKE2b-256 609329836179fc9023914d130efd4e37de325736c9a2369d860fdd9898a09e17

See more details on using hashes here.

Provenance

The following attestation bundles were made for plot_saver-0.1.6-py3-none-any.whl:

Publisher: publish.yml on javirm3/plot-saver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page