Taskiq-Flow Documentation

Version: {VERSION}

Last updated: 2026-05-05

Welcome to the official documentation for Taskiq-Flow, a powerful Python library for orchestrating asynchronous task workflows with pipelines, dataflow DAGs, real-time tracking, and distributed scheduling.

Language Selection

This documentation is available in two languages:

• English Documentation — Complete technical documentation in English (source language)
• Documentation Française — Traduction française complète

Both versions are kept synchronized, with code examples remaining in English for consistency.

Documentation Structure

The documentation is organized into the following sections:

Getting Started

• Installation — Setup instructions and configuration
• Quick Start — 5-minute tutorial to run your first pipeline
• Core Concepts — Understanding pipeline types and patterns

User Guides

• Pipelines — Sequential and dataflow pipeline patterns
• Tasks — Task definition, decorators, and metadata
• Execution — Execution models and error handling
• Tracking & Monitoring — Real-time progress and status
• WebSocket — Live event streaming
• Scheduling — Cron-based pipeline scheduling
• Retry — Error recovery and retry strategies
• Performance — Optimization and scaling
• API (REST) — FastAPI integration and endpoints

API Reference

• Core API — Pipeline, DataflowPipeline, middleware
• Decorators — @pipeline_task and utilities
• Execution — ExecutionEngine, DAG, DAGBuilder
• Tracking — TrackingManager and storage backends
• WebSocket — HookManager and event system

Examples

• Example Gallery — Walkthroughs of all example scripts
  • Basic pipeline
  • Tracking demo
  • Scheduled pipeline
  • Dataflow audio pipeline
  • Registry discovery
  • WebSocket demo
  • REST API

Quick Overview

Taskiq-Flow combines taskiq-pipelines’ orchestration with pipefunc’s dataflow model:

• Sequential Pipelines — Linear workflows with .call_next(), .map(), .filter(), .group()
• Dataflow Pipelines — Automatic DAG construction from task dependencies using @pipeline_task
• Real-time Tracking — Monitor execution with PipelineTrackingManager
• WebSocket Streaming — Live events for dashboard integration
• Scheduling — Cron-based pipeline execution with APScheduler
• REST API — FastAPI endpoints for remote management
• Parallel Execution — Automatic concurrency for independent tasks
• Map-Reduce — Built-in batch processing helpers

Read the Guides

→ Getting Started (English)

→ Commencer (Français)

Quick Links

• Project Repository: GitHub - taskiq-flow
• PyPI Package: taskiq-flow
• Taskiq Documentation: taskiq-python.github.io
• Issue Tracker: GitHub Issues

Contributing

Contributions are welcome! Please read our contributing guide for details on how to submit pull requests, add features, or report bugs.

License

This project is licensed under the MIT License — see the LICENSE file for details.

---

Maintained by SoniqueBay Team · Documentation last built: 2026-05-05