airflan-workflow 0.1.0

Enterprise-Grade Workflow Orchestration for Python

AirFlan

Enterprise-Grade Workflow Orchestration for Python

AirFlan is a lightweight, modular, and robust workflow orchestrator designed for building complex data pipelines with ease. It combines a simple Pythonic API with powerful enterprise features like parallel execution, caching, retries, and a state-of-the-art monitoring dashboard.

---

Features

• DAG Orchestration: Automatically resolves dependencies and executes tasks in topological order.
• Parallel Execution: True parallel task processing using thread pools.
• Robust Error Handling: Built-in retries, timeouts, and error propagation.
• Smart Caching: Avoid redundant computation with result caching.
• Context Sharing: Thread-safe data passing between tasks.
• Enterprise UI: A professional, minimalist dashboard for real-time monitoring and visualization.
• Modular Architecture: Extensible design with pluggable executors and storage backends.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/airflan.git
   cd airflan
   

2. Install dependencies:

   pip install -r requirements.txt
   

Local Development (Editable Install)

If you want to use AirFlan in another project locally without publishing to PyPI:

1. Navigate to your other project's directory.
2. Install AirFlan in editable mode:

   pip install -e /path/to/cloned/airflan
   

   (Replace /path/to/cloned/airflan with the actual path to this repository)

Quick Start

Define your workflow using the simple decorator API:

from airflan import WorkflowOrchestrator, WorkflowContext

# Initialize
wf = WorkflowOrchestrator(name="data_pipeline")

# Define Tasks
@wf.task(name="extract")
def extract_data():
    return [1, 2, 3]

@wf.task(name="process", depends_on=["extract"])
def process_data(context: WorkflowContext):
    # Access upstream data or shared context
    return "Processed"

# Run
if __name__ == "__main__":
    wf.run(parallel=True, enable_ui=True)

Monitoring Dashboard

AirFlan includes a professional real-time monitoring dashboard built with Streamlit.

To launch the UI, simply run your workflow with enable_ui=True. The dashboard provides:

• Interactive DAG: Visualize your workflow structure.
• Real-time Metrics: Track running, completed, and failed tasks.
• Execution Logs: Live stream of task logs.
• Performance Stats: Task duration and status distribution.

Project Structure

AirFlan/
├── airflan/               # Core Library
│   ├── core/              # Task, Scheduler, Executor, Context
│   ├── storage/           # Cache & State Management
│   └── orchestrator.py    # Main Entry Point
├── air_flan_ui.py         # Monitoring Dashboard
├── demo_workflow.py       # Example Enterprise Pipeline
└── requirements.txt       # Dependencies

Advanced Usage

Check out docs/how_to.md for detailed guides on:

• Sequential vs. Parallel Execution
• Context Management
• Retry Policies & Timeouts
• Result Caching

License

MIT License