Skip to main content

A workflow engine with sugar syntax

Project description

🐇 Pyoco

pyoco is a minimal, pure-Python DAG engine for defining and running simple task-based workflows.

Overview

Pyoco is designed to be significantly smaller, lighter, and have fewer dependencies than full-scale workflow engines like Airflow. It is optimized for local development and single-machine execution.

You can define tasks and their dependencies entirely in Python code using decorators and a simple API. There is no need for complex configuration files or external databases.

It is ideal for small jobs, development environments, and personal projects where a full-stack workflow engine would be overkill.

✨ Features

  • Pure Python: No external services or heavy dependencies required.
  • Minimal DAG model: Tasks and dependencies are defined directly in code.
  • Task-oriented: Focus on "small workflows" that should be easy to read and maintain.
  • Friendly trace logs: Runs can be traced step by step from the terminal with cute (or plain) logs.
  • Parallel Execution: Automatically runs independent tasks in parallel.
  • Artifact Management: Easily save and manage task outputs and files.
  • Observability: Track execution with unique Run IDs and detailed state transitions.
  • Control: Cancel running workflows gracefully with Ctrl+C.

📦 Installation

pip install pyoco

🚀 Usage

Here is a minimal example of a pure-Python workflow.

from pyoco import task
from pyoco.core.models import Flow
from pyoco.core.engine import Engine

@task
def fetch_data(ctx):
    print("🐰 Fetching data...")
    return {"id": 1, "value": "carrot"}

@task
def process_data(ctx, data):
    print(f"🥕 Processing: {data['value']}")
    return data['value'].upper()

@task
def save_result(ctx, result):
    print(f"✨ Saved: {result}")

# Define the flow
flow = Flow(name="hello_pyoco")
flow >> fetch_data >> process_data >> save_result

# Wire inputs (explicitly for this example)
process_data.task.inputs = {"data": "$node.fetch_data.output"}
save_result.task.inputs = {"result": "$node.process_data.output"}

if __name__ == "__main__":
    engine = Engine()
    engine.run(flow)

Run it:

python examples/hello_pyoco.py

Output:

🐇 pyoco > start flow=hello_pyoco
🏃 start node=fetch_data
🐰 Fetching data...
✅ done node=fetch_data (0.30 ms)
🏃 start node=process_data
🥕 Processing: carrot
✅ done node=process_data (0.23 ms)
🏃 start node=save_result
✨ Saved: CARROT
✅ done node=save_result (0.30 ms)
🥕 done flow=hello_pyoco

See examples/hello_pyoco.py for the full code.

🏗️ Architecture

Pyoco is designed with a simple flow:

+-----------+        +------------------+        +-----------------+
| User Code |  --->  | pyoco.core.Flow  |  --->  | trace/logger    |
| (Tasks)   |        | (Engine)         |        | (Console/File)  |
+-----------+        +------------------+        +-----------------+
  1. User Code: You define tasks and flows using Python decorators.
  2. Core Engine: The engine resolves dependencies and executes tasks (in parallel where possible).
  3. Trace: Execution events are sent to the trace backend for logging (cute or plain).

🎭 Modes

Pyoco has two output modes:

  • Cute Mode (Default): Uses emojis and friendly messages. Best for local development and learning.
  • Non-Cute Mode: Plain text logs. Best for CI/CD and production monitoring.

You can switch modes using an environment variable:

export PYOCO_CUTE=0  # Disable cute mode

Or via CLI flag:

pyoco run --non-cute ...

📚 Documentation

💖 Contributing

We love contributions! Please feel free to submit a Pull Request.


Made with 🥕 by the Pyoco Team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyoco-0.3.0.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyoco-0.3.0-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

Details for the file pyoco-0.3.0.tar.gz.

File metadata

  • Download URL: pyoco-0.3.0.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.12

File hashes

Hashes for pyoco-0.3.0.tar.gz
Algorithm Hash digest
SHA256 48bcf0dca11d116e03b8da7f4c36460ec6d4d720e8070cd853a87c0d31dfdee2
MD5 cc10a0308d138f8b8e223077aafdecc1
BLAKE2b-256 e89f3aa754db7ff0ff29e66c74961114fa0d5dd5fdfb166a5a0baa7ead8d2afb

See more details on using hashes here.

File details

Details for the file pyoco-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: pyoco-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 27.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.12

File hashes

Hashes for pyoco-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 34d57fc3ff19d38b4f79af096485fa538547d61e3cb6e0b754434e71a0496145
MD5 29e33bb75aae226552843230e6f59c9e
BLAKE2b-256 b7be362031be3523fe1311acfe2cd3bf5d1b39df9f7f6a1120e4505d7e8b16ba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page