pyoco 0.1.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

pyoco-0.5.0.dist-info/METADATA

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: pyoco
+Version: 0.5.0
+Summary: A workflow engine with sugar syntax
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: uvicorn>=0.20.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: prometheus-client>=0.20.0
+
+# 🐇 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
+
+```bash
+pip install pyoco
+```
+
+## 🚀 Usage
+
+Here is a minimal example of a pure-Python workflow.
+
+```python
+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:
+
+```bash
+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](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:
+
+```bash
+export PYOCO_CUTE=0  # Disable cute mode
+```
+
+Or via CLI flag:
+
+```bash
+pyoco run --non-cute ...
+```
+
+## 🔭 Observability Bridge (v0.5)
+
+- `/metrics` exposes Prometheus counters (`pyoco_runs_total`, `pyoco_runs_in_progress`) and histograms (`pyoco_task_duration_seconds`, `pyoco_run_duration_seconds`). Point Grafana/Prometheus at it to watch pipelines without opening sockets.
+- `/runs` now accepts `status`, `flow`, `limit` query params; `/runs/{id}/logs?tail=100` fetches only the latest snippets for dashboards.
+- Webhook notifications fire when runs COMPLETE/FAIL—configure via `PYOCO_WEBHOOK_*` env vars and forward to Slack or your alerting stack.
+- Import `docs/grafana_pyoco_cute.json` for a lavender/orange starter dashboard (3 panels: in-progress count, completion trend, per-flow latency).
+- 詳細な手順は [docs/observability.md](docs/observability.md) を参照してください。
+
+## 🧩 Plug-ins
+
+Need to share domain-specific tasks? Publish an entry point under `pyoco.tasks` and pyoco will auto-load it. See [docs/plugins.md](docs/plugins.md) for the `PluginRegistry` decorator, example `pyproject.toml`, and `pyoco plugins list` CLI helper.
+
+## 📚 Documentation
+
+- [Tutorials](docs/tutorial/index.md)
+- [Roadmap](docs/roadmap.md)
+
+## 💖 Contributing
+
+We love contributions! Please feel free to submit a Pull Request.
+
+---
+
+*Made with 🥕 by the Pyoco Team.*

pyoco-0.5.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+pyoco/__init__.py,sha256=E2pgDGvGRSVon7dSqIM4UD55LgVpf4jiZZA-70kOcuw,409
+pyoco/client.py,sha256=Y95NmMsOKTJ9AZJEg_OzHamC_w32YWmSVS653mpqHVQ,3141
+pyoco/socketless_reset.py,sha256=KsAF4I23_Kbhy9fIWFARzV5QaIOQqbl0U0yPb8a34sM,129
+pyoco/cli/entry.py,sha256=zPIG0Gx-cFO8Cf1Z3wD3Ifz_2sHaryHZ6mCRri2WEqE,93
+pyoco/cli/main.py,sha256=W3U-T4SliJHy4wZ70QoN2c9Mep--XxlEa8YkHe9DLuU,16515
+pyoco/core/base_task.py,sha256=z7hOFntAPv4yCADapS-fhtLe5eWqaO8k3T1r05YEEUE,2106
+pyoco/core/context.py,sha256=TeCUriOmg7qZB3nMRu8HPdPshMW6pMVx48xZLY6a-A4,6524
+pyoco/core/engine.py,sha256=iX2Id8ryFt-xeZgraqnF3uqkI6ubiZt5NBNYWX6Qv1s,24166
+pyoco/core/exceptions.py,sha256=G82KY8PCnAhp3IDDIG8--Uh3EfVa192zei3l6ihfShI,565
+pyoco/core/models.py,sha256=8faYURF43-7IebqzTIorHxpCeC4TZfoXWjGyPNaWhyI,10501
+pyoco/discovery/loader.py,sha256=vC729i1bR358u6YwiVX2uonZ80WxjFGFqJRlhX89Sf0,5942
+pyoco/discovery/plugins.py,sha256=pNMWxS03jWPuUV2tApGch2VL40EyKLOOeYT-OPBBBRQ,2806
+pyoco/dsl/__init__.py,sha256=xWdb60pSRL8lNFk4GHF3EJ4hon0uiWqpv264g6-4gdg,45
+pyoco/dsl/expressions.py,sha256=BtEIxPSf3BU-wPNEicIqX_TVZ4fAnlWGrzrrfc6pU1g,4875
+pyoco/dsl/nodes.py,sha256=qDiIEsAJHnD8dpuOd-Rpy6OORCW6KDW_BdYiA2BKu18,1041
+pyoco/dsl/syntax.py,sha256=kYP5uGbwxmkSd_zeSksax8iWm_7UlRW5JxE9_DoSqbk,8638
+pyoco/dsl/validator.py,sha256=HXjcc-GzjH72YByaNxAg_7YOZsVsFDFnUaenVwd5PbY,3576
+pyoco/schemas/config.py,sha256=KkGZK3GxTHoIHEGb4f4k8GE2W-aBN4iPzmc_HrwuROU,1735
+pyoco/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyoco/server/api.py,sha256=vu2ieDZgHbi8cysO2rS-lcxqWiSQprIcqRn6GkwTtKo,3890
+pyoco/server/metrics.py,sha256=92sHZKka_yBNBGlHZgRIteywx97aoTa-MnXh3UJ0HJY,2952
+pyoco/server/models.py,sha256=ir5AuvyXQigmaynA7bS_0RNJcJo2VtpJl0GjRZrj2rU,786
+pyoco/server/store.py,sha256=ITYAV1QlPWDnceywqjjJZW9E0CyocFlPmqqfjcoM-wA,9133
+pyoco/server/webhook.py,sha256=fBSLWTDN7sIWSK0AUVuiCSdVVBFV_AyP-XEKOcdMXmQ,3643
+pyoco/trace/backend.py,sha256=a1css94_lhO4SGSPHZ1f59HJqFQtZ5Sjx09Kw7v5bsk,617
+pyoco/trace/console.py,sha256=I-BcF405OGLWoacJWeke8vTT9M5JxSBpJL-NazVyxb4,1742
+pyoco/worker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyoco/worker/client.py,sha256=862KccXRtfG7zd9ZSLqrpVSV6ev8zeuEHHdtAfLghiM,1557
+pyoco/worker/runner.py,sha256=hyKn5NbuIuF-109CnQbYc8laKbWmwe9ChaLrNUtsVIg,6367
+pyoco-0.5.0.dist-info/METADATA,sha256=SEow4x2y_O6SqeVuEU-_7dT12F-XA24sYVD_hMV6TQM,5251
+pyoco-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyoco-0.5.0.dist-info/top_level.txt,sha256=2JRVocfaWRbX1VJ3zq1c5wQaOK6fMARS6ptVFWyvRF4,6
+pyoco-0.5.0.dist-info/RECORD,,

pyoco-0.1.0.dist-info/METADATA

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: pyoco
-Version: 0.1.0
-Summary: A workflow engine with sugar syntax
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Requires-Dist: pyyaml>=6.0.3

pyoco-0.1.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-pyoco/__init__.py,sha256=E2pgDGvGRSVon7dSqIM4UD55LgVpf4jiZZA-70kOcuw,409
-pyoco/cli/entry.py,sha256=zPIG0Gx-cFO8Cf1Z3wD3Ifz_2sHaryHZ6mCRri2WEqE,93
-pyoco/cli/main.py,sha256=uRc6CzUTVRYF4JbehlbrprT7GvWQ-WyBZ8k12NrSxO8,6502
-pyoco/core/base_task.py,sha256=z7hOFntAPv4yCADapS-fhtLe5eWqaO8k3T1r05YEEUE,2106
-pyoco/core/context.py,sha256=SnoTz3vRghO1A-FNOrw2NEjbx1HySDqrBnQU5-KWGbk,3696
-pyoco/core/engine.py,sha256=m5LrEsXcpUAran5DxULtWbvhsMNj5mv17wE6lDFkFmQ,11416
-pyoco/core/models.py,sha256=zTt5HTSBChwRpOuw3qY2pvjRGZVsq4OQ-ZBHE3ujMWA,4548
-pyoco/discovery/loader.py,sha256=XzZzOAyFYrdA8K6APuEGWgjSIyp4Bgwlr834MyJc8vk,4950
-pyoco/dsl/__init__.py,sha256=xWdb60pSRL8lNFk4GHF3EJ4hon0uiWqpv264g6-4gdg,45
-pyoco/dsl/syntax.py,sha256=AkFcD5gLlbJLFN0KkMIyttpHUV3v21pjz_ZqwreZkdM,4312
-pyoco/schemas/config.py,sha256=KkGZK3GxTHoIHEGb4f4k8GE2W-aBN4iPzmc_HrwuROU,1735
-pyoco/trace/backend.py,sha256=h7l1PU8zuCSOo_VA5T1ax4znN_Az3Xuvx-KXibg3e-U,597
-pyoco/trace/console.py,sha256=Kf2-vma98ojhVQZHFzCUYfD_46Lr1WfAfI56smZkSZM,1397
-pyoco-0.1.0.dist-info/METADATA,sha256=bA_qJXUkIiC7TIOSo8CEzJ6PXp01pLQ1Q1LoMOrIw_k,187
-pyoco-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyoco-0.1.0.dist-info/top_level.txt,sha256=2JRVocfaWRbX1VJ3zq1c5wQaOK6fMARS6ptVFWyvRF4,6
-pyoco-0.1.0.dist-info/RECORD,,