Example Gallery
Working examples demonstrating key Taskiq-Flow features and patterns
Version: {VERSION} Related: Quick Start Guide
Overview
This gallery provides in-depth walkthroughs of the example scripts included in the examples/ directory. Each example demonstrates a specific feature or integration pattern.
Example Index
| Example | Description | Key Concepts |
|---|---|---|
| Basic Pipeline | Simple sequential pipeline with map, filter, and group operations | SequentialPipeline, basic steps |
| Tracking Demo | Real-time pipeline monitoring with PipelineTrackingManager | Tracking, status storage, visualization |
| Scheduled Pipeline | Cron-based recurring pipeline execution | PipelineScheduler, APScheduler, timezones |
| Dataflow Audio Pipeline | Full DAG with parallelism, map-reduce, and visualization | DataflowPipeline, automatic DAG, parallelism |
| DAG Visualization Demo | NetworkX DAG analysis: critical path, parallel groups, multi-format export | DAGVisualizer, NetworkX, critical path, exports |
| NiceGUI DAG Demo | Interactive web DAG viewer via NiceGUI and MermaidGenerator | MermaidGenerator, NiceGUI, interactive web visualization |
| Registry Discovery | Manual DataflowRegistry construction, DAG inspection, and low-level execution | DataflowRegistry, ExecutionEngine, DAG introspection |
| WebSocket Demo | Real-time event streaming via WebSockets | HookManager, WebSocket transport, live tracking |
| REST API | FastAPI integration for remote pipeline management | PipelineVisualizationAPI, custom endpoints |
Running the Examples
Each example page includes:
- Overview — What the example demonstrates
- Prerequisites — Required dependencies and setup
- Code Walkthrough — Line-by-line explanation
- Key Concepts — Core features highlighted
- Running Instructions — How to execute the script
- Expected Output — Sample output for verification
- Common Issues — Troubleshooting tips
To run an example:
# Navigate to the repository root
cd taskiq-flow
# Install dependencies if needed
pip install -e .
# Run an example script
python examples/quickstart.py
Some examples require additional services (Redis, etc.). See individual example pages for specifics.
Example Categories
Getting Started
- Basic Pipeline — Start here if you’re new
Monitoring & Operations
Advanced Workflows
Integration
Next Steps
- Quick Start Guide — Run your first pipeline
- User Guides — Deep dives into each feature
- API Reference — Complete module documentation