Welcome¶

aipartnerupflow is a Python framework for orchestrating and executing tasks. It manages when tasks run, how they depend on each other, and ensures everything executes in the right order.

Key Features¶

• Simple Task Management - Create, organize, and execute tasks with ease
• Dependency Handling - Tasks automatically wait for their dependencies to complete
• Flexible Execution - Support for custom tasks, LLM agents (CrewAI), and more
• Production Ready - Built-in storage, streaming, and API support
• Extensible - Easy to add custom task types and integrations

Quick Start¶

New to aipartnerupflow? Get up and running in 5 minutes!

Quick Start Guide

Core Concepts

Examples

Documentation Sections¶

Popular Guides¶

For Users¶

• Task Orchestration - Complete guide to task orchestration, dependencies, and priorities
• Custom Tasks - Guide to creating custom tasks with ExecutableTask interface
• CLI - Complete CLI usage guide
• API Server - API server setup and usage guide
• Best Practices - Best practices and recommendations

For Developers¶

• Python API - Core Python library API reference (TaskManager, ExecutableTask, TaskTreeNode, etc.)
• HTTP API - A2A Protocol Server HTTP API reference
• Extending - Guide for extending the framework (custom executors, extensions, hooks)
• Contributing - Contribution guidelines and process

Architecture & Design¶

• Architecture Overview - System architecture and design principles
• Directory Structure - Directory structure and naming conventions
• Naming Convention - Naming conventions for extensions
• Extension Registry Design - Extension registry design (Protocol-based architecture)
• Configuration - Database table configuration

Examples & Tutorials¶

• Basic Task - Basic task examples and common patterns
• Task Tree - Task tree examples with dependencies and priorities
• Real World Examples - Real-world use cases and examples
• First Steps Tutorial - Complete beginner tutorial

Learning Paths¶

New to aipartnerupflow?¶

1. Core Concepts (5 min) - Learn the fundamental ideas
2. Quick Start (10 min) - Build your first task
3. First Steps Tutorial - Complete beginner tutorial

Ready to Build?¶

1. Task Orchestration Guide - Deep dive into task management
2. Custom Tasks Guide - Create your own task types
3. Examples - Copy-paste ready examples

Production Ready?¶

1. Best Practices - Production recommendations
2. API Reference - Complete API documentation
3. Architecture Overview - Understand the system design

Additional Resources¶

• GitHub Repository - Source code and issues
• PyPI Package - Install from PyPI
• Protocol Documentation - A2A Protocol specification

Need Help?¶

Check out our FAQ for common questions and answers.