Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

panel-flowdash

CI conda-forge pypi-version python-version

A dataflow-driven dashboard builder for Panel. Define reusable components with typed input/output ports, wire them together visually, and persist layouts to SQLite, JSON files or a store of your own.

Features

  • Component registry with the @register decorator for metadata-driven discovery
  • Typed ports with automatic introspection from param.output decorators and Viewer params
  • Dataflow engine with cycle detection, type checking, single-source-per-input validation, and runtime error reporting
  • Edge transforms that reshape the value carried along a connection (pick a column, filter, sort, aggregate, format) without writing a component
  • Persistence of dashboard layouts, edges, and tile configurations to SQLite, a folder of JSON files, or your own store
  • CLI (flowdash serve) to launch a project directory as a full dashboard app
  • Embeddable editor (FlowDash) for using the canvas and layout editor inside your own Panel app

Installation

pip install panel-flowdash

panel-flowdash needs Python 3.12 or newer and Panel 1.11 or newer.

Quickstart

Create a project directory with component modules:

my_project/
    Analytics/
        selector.py
        chart.py

Define components with typed ports:

# Analytics/selector.py
from panel_flowdash import register

@register(page=False, component=True, provides=[{"key": "company", "type": "str"}])
def app(config):
    import panel_material_ui as pmui

    select = pmui.Select(label="Company", options=["ACME", "Globex"])
    config.company = select.param.value  # publish the selection on the output port
    return select
# Analytics/chart.py
from panel_flowdash import register

@register(page=False, component=True, requires=[{"key": "company", "type": "str"}])
def app(config):
    import panel as pn

    def title(company):
        return f"# Chart for {company}"

    return pn.pane.Markdown(pn.bind(title, config.param.company))

config holds one parameter per port. A component publishes an output by assigning to it, and reacts to an input by depending on config.param.<port>.

Serve it:

flowdash serve my_project/

Using Viewer classes

Components can also be Panel Viewer subclasses. Ports are introspected automatically from params and @param.output decorators:

import param
import panel as pn
import panel_material_ui as pmui
from panel_flowdash import register

@register(component=True)
class StockFilter(pn.viewable.Viewer):
    ticker = param.String(default="AAPL")

    @param.output(param.DataFrame)
    def filtered_data(self):
        ...

    def __panel__(self):
        return pmui.TextInput.from_param(self.param.ticker)

Embedding the editor

The project-directory workflow is optional. FlowDash is the editor on its own, without the routing, pages and navigation that flowdash serve layers on top:

from panel_flowdash import FlowDash

editor = FlowDash("my_project/", store="dashboards.db")

src = editor.add_component("Analytics/selector")
dst = editor.add_component("Analytics/chart")
editor.connect(src, "company", dst, "company")

editor.servable()

Components can be passed as decorated functions, Viewer subclasses, a mapping of explicit ids, a project directory, or any mix. See Embed the Editor for building dashboards in code, persistence, and read-only viewers.

CLI

flowdash serve <project-dir> [options]
Option Description
--port Port to serve on (default: 5006)
--db-path SQLite database path (default: <project-dir>/dashboards.db)
--title Browser tab title
--dev Enable autoreload
--admin Enable Panel admin interface

Run flowdash serve --help for the full list.

Development

git clone https://github.com/panel-extensions/panel-flowdash
cd panel-flowdash
pip install -e ".[dev]"
pytest tests

Contributing

Contributions are welcome! Please fork the repository, create a feature branch, and open a pull request.

Metadata

Release files for panel-flowdash 0.1.0rc4

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

Source distribution (sdist)

Source distribution for panel-flowdash 0.1.0rc4
File Size Uploaded Provenance Actions
panel_flowdash-0.1.0rc4.tar.gz 2.2 MB With provenance Details for panel_flowdash-0.1.0rc4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for panel-flowdash 0.1.0rc4
File Interpreter ABI Platform Actions
panel_flowdash-0.1.0rc4-py3-none-any.whl Python 3 none any Details for panel_flowdash-0.1.0rc4-py3-none-any.whl

Total release size: 2.7 MB

Release files / panel_flowdash-0.1.0rc4.tar.gz

Download URL panel_flowdash-0.1.0rc4.tar.gz
Size 2.2 MB
Tags Source
SHA-256 checksum
How to use checksums
b18dff0b66be4563cc22fa7b15c269e68a4f4010f7ba52c925a2ec82b2431da9
BLAKE2b-256 checksum
How to use checksums
ad59e9ba5ad86dfdb8e243d051825edbd0cd1d0af5af65336f444247d978af63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

Release files / panel_flowdash-0.1.0rc4-py3-none-any.whl

Download URL panel_flowdash-0.1.0rc4-py3-none-any.whl
Size 539.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
facb8e479ba8b6fa7004e0a22a7f344cfa20b123d56f468354fd13e0b564639d
BLAKE2b-256 checksum
How to use checksums
495a1725eefaf52e8a9f7f88da2b58e955b88e5a2c4f511180b7b2c8c9699e94
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

Security for panel-flowdash 0.1.0rc4

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for panel_flowdash-0.1.0rc4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

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