pathway-viz 0.1.1

The visualization layer for Pathway - real-time dashboards for streaming data

PathwayViz

Real-time dashboards for streaming data pipelines. Zero config, embeddable, fast.

What is PathwayViz?

Pathway handles streaming aggregations. PathwayViz makes them visible.

import pathway as pw
import pathway_viz as pv

orders = pw.io.kafka.read(...)
totals = orders.reduce(revenue=pw.reducers.sum(pw.this.amount))

pv.stat(totals, "revenue", title="Revenue", unit="$")
pv.start()
pw.run()

Open http://localhost:3000 → live dashboard.

Note: the Python module name is pathway_viz (e.g. import pathway_viz as pv).

Install

pip install pathway-viz            # Basic
pip install pathway-viz[pathway]   # With Pathway
pip install pathway-viz[all]       # Everything

Quick Start

pip install pathway-viz

# Run demos
pathway-viz demo --mode simple   # No Docker required
pathway-viz demo                 # E-commerce demo (requires Docker)

# Scaffold a new project
pathway-viz init my-dashboard           # Creates project with Docker files
pathway-viz init my-dashboard --k8s     # Include Kubernetes manifests

# View templates
pathway-viz templates                   # List all templates
pathway-viz show docker-compose         # Print template to stdout

Widgets

Widget	Purpose	Example
stat	Big numbers	pv.stat("revenue", title="Revenue", unit="$")
chart	Time series	pv.chart("latency", title="Latency", unit="ms")
gauge	Bounded values	pv.gauge("cpu", title="CPU", max_val=100)
table	Live rows	pv.table("events", columns=["time", "msg"])

Embedding

pv.configure(embed=True)
pv.stat("revenue", title="Revenue")
pv.start()

<iframe src="http://localhost:3000/embed/revenue"></iframe>

Documentation

For comprehensive guides, see the docs/ folder:

• Concepts — How PathwayViz, Pathway, and windowing work
• Widgets — All widget types with parameters and examples
• Persistence — DuckDB, Pathway checkpointing, surviving restarts
• Deployment — Docker, Kubernetes, reverse proxy setup
• E-commerce Example — Kafka + Pathway demo with embedded widgets and optional DuckDB persistence

Docker

Pre-built images are available on Docker Hub:

# Pull the image
docker pull mvfolino68/pathway-viz:latest

# Run the simple demo
docker run -p 3000:3000 mvfolino68/pathway-viz pathway-viz demo --mode simple

# Or use your own pipeline
docker run -p 3000:3000 -v $(pwd)/my_pipeline.py:/app/pipeline.py \
  mvfolino68/pathway-viz python /app/pipeline.py

CLI Reference

pathway-viz demo [--mode simple|pathway] [--port PORT]   # Run demos
pathway-viz init DIRECTORY [--k8s] [--force]             # Scaffold project
pathway-viz show TEMPLATE                                 # Print template
pathway-viz templates                                     # List templates

Architecture

Pathway Pipeline → PathwayViz Python (`pathway_viz`) → Rust WebSocket Server → Browser
                                              ↓
                                      Ring buffers for history

The Rust WebSocket server handles high-throughput broadcast without Python GIL bottlenecks.

License

MIT