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.0rc5

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.0rc5
File Size Uploaded Provenance Actions
panel_flowdash-0.1.0rc5.tar.gz 2.3 MB With provenance Details for panel_flowdash-0.1.0rc5.tar.gz

Built distribution (wheel)

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

Total release size: 2.9 MB

Release files / panel_flowdash-0.1.0rc5.tar.gz

Download URL panel_flowdash-0.1.0rc5.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
d9a1955ce507dbdd91521fe7da3160a53702fab9bc12adfbe544e5142e202fd3
BLAKE2b-256 checksum
How to use checksums
84fdc6965b5eb8c331ceb44fa20ccee9e06ce244ec795f09387b818b73c85ae8
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 20, 2026.

Transparency log

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

Download URL panel_flowdash-0.1.0rc5-py3-none-any.whl
Size 610.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d58e2fdcdbf8b1f21fc0f30c5363e7c943c3bda1df2c9edb9ef7fbdddf3c5e63
BLAKE2b-256 checksum
How to use checksums
0c16b890607920ebc60a18bec5d02a28c8a2f9e68b51b03c70fc89e11a10e964
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 20, 2026.

Transparency log

Security for panel-flowdash 0.1.0rc5

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.0rc5.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 20, 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