Skip to main content

renderflow

Workflow runtime and rendering API for:

  • Streamlit UI
  • CLI execution
  • HTML report export
  • Individual figure export

Core Idea

renderflow owns the interface contract and rendering behavior. Provider packages should mostly define workflows (run_workflow + params), not custom UI/CLI plumbing.

Demo App

Live Streamlit demo:

https://demo-for-renderflow.streamlit.app/

CLI

List installed providers:

renderflow list-providers

List provider workflows:

renderflow list-workflows --provider crsd-inspector

Show interpreted workflow parameters:

renderflow show-params --provider crsd-inspector --workflow signal_analysis

Provider-scoped CLI (no provider cli.py needed):

[project.scripts]
crsd-inspector = "renderflow.cli:main"

With that entrypoint:

  • crsd-inspector -h shows available workflows.
  • crsd-inspector range_doppler_processing -h shows only that workflow's parameters/defaults/help.

Execute a workflow in terminal mode:

renderflow execute \
  --provider crsd-inspector \
  --workflow signal_analysis \
  --param crsd_directory=examples \
  --param prf_hz=1000 \
  --output terminal

Execute and export both:

  • one combined report file (--html)
  • per-figure files (--save-figures-dir + --figure-format)
renderflow execute \
  --provider crsd-inspector \
  --workflow signal_analysis \
  --param crsd_directory=examples \
  --html output/report.html \
  --save-figures-dir output/figures \
  --figure-format html

Add per-figure JSON in the same run:

renderflow execute \
  --provider crsd-inspector \
  --workflow signal_analysis \
  --param crsd_directory=examples \
  --html output/report.html \
  --save-figures-dir output/figures \
  --figure-format html \
  --figure-format json

Export multiple figure formats in a single run:

renderflow execute \
  --provider crsd-inspector \
  --workflow signal_analysis \
  --param crsd_directory=examples \
  --save-figures-dir output/figures \
  --figure-format html \
  --figure-format json

Comma-separated format lists are also accepted:

renderflow execute \
  --provider crsd-inspector \
  --workflow signal_analysis \
  --param crsd_directory=examples \
  --html output/report.html \
  --save-figures-dir output/figures \
  --figure-format html,json

If --figure-format is omitted, per-figure export defaults to html. Image formats (png, jpg, jpeg, svg, pdf) require Kaleido. renderflow includes kaleido as a dependency.

Launch Streamlit:

renderflow run --provider crsd-inspector

Shell Completion

Tab completion is supported via argcomplete for both:

  • renderflow ...
  • provider-scoped commands (for example crsd-inspector ...)

Activate in Bash for current shell:

eval "$(register-python-argcomplete renderflow)"
eval "$(register-python-argcomplete crsd-inspector)"

After activation, workflow subcommands and options complete with Tab.

Workflow Result Contract

Use renderflow.workflow.Workflow inside provider workflows:

from renderflow.workflow import Workflow

workflow = Workflow(name="My Workflow", description="...")
workflow.params = {
    "threshold": {
        "type": "number",
        "default": 0.5,
        "label": "Threshold",
        "description": "Minimum score to keep",
    },
}

workflow.add_text("Summary text")
workflow.add_table("Metrics", {"name": ["a"], "value": [1]})
workflow.add_plot(fig, title="Spectrum", figure_id="spectrum", save=True)
workflow.add_code("print('debug')", language="python")
return workflow.build()

add_plot(..., save=False) marks a plot as not exportable when using figure-save operations.

Minimum return contract from run_workflow(...):

  • must return a dict
  • either:
    • modern shape: {"results": [ ... ]}
    • legacy shape: {"text": [...], "tables": [...], "plots": [...]}
  • for modern shape, each item in results must be a dict with:
    • type in text | table | plot | code
    • if type == "plot", item must include figure

Provider Contract Options

1) Explicit AppSpec (fully explicit)

Entry point:

[project.entry-points."renderflow.providers"]
my-provider = "my_provider.app_definition:get_app_spec"

get_app_spec() returns renderflow.contracts.AppSpec.

2) Auto-Defined Provider (minimal)

If no app_definition exists, renderflow auto-builds from:

  • <provider>.workflows.* modules with run_workflow(...)
  • optional <provider>.renderflow module:
    • APP_NAME = "..."
    • WORKFLOWS_PACKAGE = "provider.custom_workflows" (optional)
    • optional custom metadata constants for provider setup

Workflow parameters are pulled from:

  1. workflow.params if a workflow object exists in the module
  2. PARAMS module global
  3. inferred function signature defaults

This lets packages like crsd-inspector keep only workflow definitions and optional init logic, while renderflow handles CLI + Streamlit parameter interpretation and rendering.

Dynamic Dropdown Options

For dropdown params, options can be either:

  • a static list ([{"label": ..., "value": ...}] or [value1, value2])
  • a callable: options(values, spec) that returns options dynamically

values contains current parameter values during Streamlit rendering, so providers can implement dependent dropdowns (for example, file list based on selected directory).

Metadata

Release files for renderflow 2026.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for renderflow 2026.10
File Size Uploaded Provenance Actions
renderflow-2026.10.tar.gz 21.3 kB Without provenance Details for renderflow-2026.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for renderflow 2026.10
File Interpreter ABI Platform Actions
renderflow-2026.10-py3-none-any.whl Python 3 none any Details for renderflow-2026.10-py3-none-any.whl

Total release size: 41.9 kB

Release files / renderflow-2026.10.tar.gz

Download URL renderflow-2026.10.tar.gz
Size 21.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b3c8c3c380f435ac819fe2e4035faad2a4c8a63f966ecf21675363a3b1e3d311
BLAKE2b-256 checksum
How to use checksums
2e1d2332fa96a4e1d62c10b7247dd38232f82b6bcc1b4571bbb46e0be89610fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / renderflow-2026.10-py3-none-any.whl

Download URL renderflow-2026.10-py3-none-any.whl
Size 20.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1420b353c0f41d2fc4041a2f88dbfcc03a20849c47b9572ada92bf4196a1a552
BLAKE2b-256 checksum
How to use checksums
dde9292510903de1c51e16de1c24f75908d2d2e1796ba948ab0514a8bc755d9f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for renderflow 2026.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page