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.

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
  • SQLite persistence for dashboard layouts, edges, and tile configurations
  • CLI (flowdash serve) to launch a project directory as a full dashboard app

Installation

pip install panel-flowdash

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(component=True, provides=[{"key": "company", "type": "str"}])
def app(config):
    import panel_material_ui as pmui
    return pmui.Select(name="Company", options=["ACME", "Globex"])

# Analytics/chart.py
from panel_flowdash import register

@register(component=True, requires=[{"key": "company", "type": "str"}])
def app(config):
    import panel as pn
    return pn.pane.Markdown(f"# Chart for {config.get('company', '...')}")

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
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 pn.widgets.TextInput.from_param(self.param.ticker)

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.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.0b3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for pyviz from gravatar.com pyviz

Credits

Author/Maintainer: Philipp Rudiger

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License (BSD)

Requires

Python >=3.10

Provides Extra

dev docs mypy

Classifiers

Report project as malware

Download files

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

Source Distribution

panel_flowdash-0.0.0a1.tar.gz (138.4 kB view details)

Uploaded Source

Built Distribution

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

panel_flowdash-0.0.0a1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file panel_flowdash-0.0.0a1.tar.gz.

File metadata

  • Download URL: panel_flowdash-0.0.0a1.tar.gz
  • Upload date:
  • Size: 138.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for panel_flowdash-0.0.0a1.tar.gz
Algorithm Hash digest
SHA256 260bd4a11f0e06ce1b527dfcda4d6c3f3a67a7f3a307daf15507dd928d240bbf
MD5 5e167b1ded64c66fef92ff8481fd5b4e
BLAKE2b-256 ad8584f7f37a97ef5bbe708de0ebbd66dc6bc19e1211260d7f206867211e3a2a

See more details on using hashes here.

Provenance

The following attestation bundles were made for panel_flowdash-0.0.0a1.tar.gz:

Publisher: build.yml on panel-extensions/panel-flowdash

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

File details

Details for the file panel_flowdash-0.0.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for panel_flowdash-0.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 aa9a1b84b073050b29b408eeea67b1609ea6058effbfb0677b730edcfc23ea73
MD5 1527a6995c28bb1c9f3e175f24a77fb2
BLAKE2b-256 29b12ae2ea8f34c6222525c2fc230b8c069a5aa80ddc4aac21fa46da7bfb5880

See more details on using hashes here.

Provenance

The following attestation bundles were made for panel_flowdash-0.0.0a1-py3-none-any.whl:

Publisher: build.yml on panel-extensions/panel-flowdash

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