Skip to main content

Cheap observability for Python processes

Project description



CI codecov PyPI - Version PyPI - Python Version

Cheap observability for Python processes, with a browser UI and almost no setup.

Live demo: https://demo.plotsrv.com
See a live instance of plotsrv rendering plots, tables, JSON, and HTML from a daily process visualising home sensor/meteorological data.

plotsrv is a lightweight Python server for exposing live Python objects and on-disk files in a single browser UI. It gives you quick visibility into pipelines, experiments, batch jobs, and long-running processes without needing a full observability stack.

Add a decorator to functions you want to expose, or publish artifacts directly from your code. Fire up the server with a single command, and plotsrv takes care of discovery, view registration, and object-specific rendering automatically.

Key features:

  • Browser UI built on FastAPI for viewing live outputs in one place
  • Automatic rendering for common Python outputs: plots, tables, JSON, text, HTML, images, code, and tracebacks
  • Minimal setup: decorate functions and launch the server
  • AST-based discovery of decorated views, so the UI can pre-populate navigation on startup
  • Optional on-disk snapshots, with historical browsing and configurable retention
  • Freshness tracking, so you can quickly see when a process is delayed or stale
  • Configuration via plotsrv.yaml, including UI settings
  • CLI-first workflow, with Python entry points available where needed

It can also watch files on disk and expose them in the same UI.

Get going

  1. Install plotsrv
pip install plotsrv

Or

uv add plotsrv
  1. Start the server

Provide a script, module or entire package.

plotsrv run your_module.py --host 127.0.0.1 --port 8000

You can also start the server from Python if needed.

  1. Expose views from your code

The main pattern is to decorate functions whose output you want to expose:

from plotsrv import plotsrv

@plotsrv(label="sales", section="insights")
def sales_plot():
    return fig

@plotsrv(label="latest", section="insights")
def latest_results():
    return df

plotsrv inspects the returned object and chooses an appropriate renderer automatically.

You can also publish artifacts directly instead of using decorators:

from plotsrv import publish_artifact

publish_artifact({"status": "ok", "rows": 123}, label="summary")

Watching files on disk

plotsrv can also expose files directly from disk, which is useful for logs, reports, HTML files, JSON outputs, CSVs, and generated artifacts.

plotsrv run src.etl --host 127.0.0.1 --port 8000 \
  --watch /var/log/etl_log.txt --watch-label etl-log --watch-section log-files --watch-tail --no-truncate

Status

plotsrv is currently pre-0.1.0 and still evolving, but is already usable for real workflows.

License

plotsrv is licensed under the Apache License 2.0.

See the LICENSE file for full details.

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

plotsrv-0.0.8.tar.gz (611.2 kB view details)

Uploaded Source

Built Distribution

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

plotsrv-0.0.8-py3-none-any.whl (494.4 kB view details)

Uploaded Python 3

File details

Details for the file plotsrv-0.0.8.tar.gz.

File metadata

  • Download URL: plotsrv-0.0.8.tar.gz
  • Upload date:
  • Size: 611.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for plotsrv-0.0.8.tar.gz
Algorithm Hash digest
SHA256 dab14ee4bbf122c1c7f0ab40dc993df2a1a608c292387093a35550b2c0a0660e
MD5 92214d590f2a742ae4ac697f25e59415
BLAKE2b-256 5888b266b5001811e39f709f579af1e88917e2898289532cf4b0181cf81c3467

See more details on using hashes here.

File details

Details for the file plotsrv-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: plotsrv-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 494.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for plotsrv-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 dd23037b56c6ed7de7b95968e0dd9a99d00277fe00b6b109a6c4a3447f21e9ab
MD5 d23961b9f727bc948ef1eb4dc832fb97
BLAKE2b-256 8a14c69ef2c60f55ddb440f436dd0888ff7da7b0112f62f07b36454531da3b6d

See more details on using hashes here.

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