celery-dag 1.0.0__tar.gz

celery_dag-1.0.0/LICENSE

@@ -0,0 +1,177 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the acting entity and all other entities
+      that control, are controlled by, or are under common control with that
+      entity. For the purposes of this definition, "control" means (i) the
+      power, direct or indirect, to cause the direction or management of
+      such entity, whether by contract or otherwise, or (ii) ownership of
+      fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
+      ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity exercising
+      permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+

celery_dag-1.0.0/PKG-INFO

@@ -0,0 +1,297 @@
+Metadata-Version: 2.4
+Name: celery-dag
+Version: 1.0.0
+Summary: Production-grade DAG workflow orchestration with Celery and PostgreSQL
+Author-email: Santosh Dhaladhuli <santoshsai666@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/SantoshDhaladhuli/celery-dag
+Project-URL: Repository, https://github.com/SantoshDhaladhuli/celery-dag
+Project-URL: Documentation, https://github.com/SantoshDhaladhuli/celery-dag#readme
+Project-URL: Issues, https://github.com/SantoshDhaladhuli/celery-dag/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Framework :: Celery
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: alembic>=1.16.0
+Requires-Dist: celery[redis,sqlalchemy]>=5.4.0
+Requires-Dist: croniter>=2.0.0
+Requires-Dist: flower>=2.1.0
+Requires-Dist: psycopg[pool]>=3.1.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: redis[hiredis]>=5.0.0
+Requires-Dist: sqlalchemy>=2.0.0
+Provides-Extra: api
+Requires-Dist: fastapi>=0.115.0; extra == "api"
+Requires-Dist: uvicorn[standard]>=0.30.0; extra == "api"
+Provides-Extra: s3
+Requires-Dist: boto3>=1.34.0; extra == "s3"
+Provides-Extra: gcs
+Requires-Dist: google-cloud-storage>=2.14.0; extra == "gcs"
+Provides-Extra: azure
+Requires-Dist: azure-storage-blob>=12.19.0; extra == "azure"
+Requires-Dist: azure-identity>=1.15.0; extra == "azure"
+Provides-Extra: storage
+Requires-Dist: boto3>=1.34.0; extra == "storage"
+Requires-Dist: google-cloud-storage>=2.14.0; extra == "storage"
+Requires-Dist: azure-storage-blob>=12.19.0; extra == "storage"
+Requires-Dist: azure-identity>=1.15.0; extra == "storage"
+Provides-Extra: all
+Requires-Dist: fastapi>=0.115.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.30.0; extra == "all"
+Requires-Dist: boto3>=1.34.0; extra == "all"
+Requires-Dist: google-cloud-storage>=2.14.0; extra == "all"
+Requires-Dist: azure-storage-blob>=12.19.0; extra == "all"
+Requires-Dist: azure-identity>=1.15.0; extra == "all"
+Dynamic: license-file
+
+<div align="center">
+
+# ⚡ Celery DAG Orchestrator
+
+**Production-grade, transactional DAG workflow orchestration for Python & Celery**
+
+[![CI](https://img.shields.io/github/actions/workflow/status/SantoshDhaladhuli/celery-dag/ci.yml?branch=main&label=CI&logo=github&color=brightgreen)](https://github.com/SantoshDhaladhuli/celery-dag/actions)
+[![Docs](https://img.shields.io/badge/docs-passing-brightgreen.svg)](https://github.com/SantoshDhaladhuli/celery-dag#readme)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![PyPI package](https://img.shields.io/pypi/v/celery-dag.svg?color=brightgreen)](https://pypi.org/project/celery-dag/)
+[![Latest Release](https://img.shields.io/github/v/release/SantoshDhaladhuli/celery-dag?color=blue&label=latest-release)](https://github.com/SantoshDhaladhuli/celery-dag/releases)
+[![Codecov](https://img.shields.io/badge/codecov-92%25-yellowgreen.svg)](https://github.com/SantoshDhaladhuli/celery-dag)
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+[![Celery](https://img.shields.io/badge/celery-5.4%2B-green.svg)](https://docs.celeryq.dev/)
+[![PostgreSQL](https://img.shields.io/badge/postgresql-14%2B-blue.svg)](https://www.postgresql.org/)
+[![Redis](https://img.shields.io/badge/redis-7.0%2B-red.svg)](https://redis.io/)
+[![Author](https://img.shields.io/badge/author-Santosh%20Dhaladhuli-orange.svg)](https://github.com/SantoshDhaladhuli)
+
+<p align="center">
+  <a href="#-quickstart">Quickstart</a> •
+  <a href="#-why-celery-dag">Why celery-dag?</a> •
+  <a href="#-core-architecture">Architecture</a> •
+  <a href="#-feature-walkthrough">Features</a> •
+  <a href="#-comparison-matrix">Comparison Matrix</a> •
+  <a href="#-rest-api--observability">REST API & Visualizer</a> •
+  <a href="#-contributing">Contributing</a>
+</p>
+
+---
+
+</div>
+
+`celery-dag` is an enterprise-grade directed acyclic graph (DAG) workflow engine built on top of **Celery**, **PostgreSQL**, and **Redis**. 
+
+It replaces Celery's fragile Canvas primitives (`chain`, `chord`, `group`) with a **relational state machine** and a **Transactional Outbox**, guaranteeing zero lost task dispatches, sub-second edge-based dependency evaluation, dynamic graph branching, and zero-compute partial reruns on pipeline failures.
+
+---
+
+## 🎯 Why `celery-dag`?
+
+Celery is an exceptional distributed task queue, but its built-in Canvas primitives suffer from fundamental architectural limitations in mission-critical environments:
+
+1. **State Ephemerality & Dual-Write Race Conditions**: Celery Canvas stores workflow state inside message headers and Redis result backends. If a worker crashes mid-chain (OOM/K8s eviction), workflow state is lost, leaving unrecoverable "ghost workflows".
+2. **Level-Wide Barrier Bottlenecks (`chord`)**: Celery `chord` forces all parallel tasks in a group to wait for the slowest task before triggering the downstream body task. `celery-dag` dispatches downstream nodes **immediately** when their specific edge dependencies complete.
+3. **Inability to Partial Rerun / Resume**: Failing task #99 in a 100-task workflow in default Celery requires re-executing the entire workflow from scratch. `celery-dag` resumes strictly from the point of failure.
+4. **Memory Bloat & Result Eviction**: Passing heavy task returns (>64 KB) through Celery results bloats Redis RAM and PostgreSQL result tables. `celery-dag` transparently offloads payloads to S3/GCS/Azure/NFS via `ArtifactStore`.
+5. **Static Topology Constraints**: Default Celery primitives cannot dynamically branch, skip unselected execution paths, or inject dynamic tasks at runtime without breaking `chord` synchronization keys.
+
+---
+
+## ⚡ Quickstart
+
+### 1. Installation
+
+```bash
+pip install celery-dag
+```
+
+For REST API, visualization, and cloud object storage support:
+```bash
+pip install "celery-dag[all]"
+```
+
+### 2. Define Tasks & Execute a DAG
+
+```python
+from celery_dag import task_hub, DAGBuilder, DAGExecutor
+
+# 1. Register task functions
+@task_hub.register("fetch_orders")
+def fetch_orders(*, region: str):
+    return {"orders": [101, 102, 103], "region": region}
+
+@task_hub.register("process_payment")
+def process_payment(*, order_data: dict):
+    orders = order_data.get("orders", [])
+    return {"processed_count": len(orders), "total_val": 450.0}
+
+@task_hub.register("send_summary")
+def send_summary(*, payment_data: dict):
+    print(f"Processed {payment_data['processed_count']} orders successfully!")
+    return {"status": "NOTIFIED"}
+
+# 2. Declaratively build immutable DAG definition
+dag = (
+    DAGBuilder("order-processing-pipeline", namespace="production", timeout=3600.0)
+    .add_node("step1", "fetch_orders", payload={"region": "US-EAST"})
+    .add_node("step2", "process_payment", dependencies=["step1"])
+    .add_node("step3", "send_summary", dependencies=["step2"])
+    .build()
+)
+
+# 3. Submit DAG to Celery engine
+executor = DAGExecutor()
+run_id = executor.submit(dag)
+print(f"Submitted workflow run ID: {run_id}")
+```
+
+---
+
+## 🛡️ Core Architecture
+
+```
++-----------------------------------------------------------------------------------+
+|                                  TRANSACTIONAL FLOW                               |
+|                                                                                   |
+|  [ API / App ]  --->  ( PostgreSQL Transaction )                                  |
+|                             |---> Update Task Status (SUCCESS)                     |
+|                             |---> Atomic Relational Dependency Check               |
+|                             |---> Insert Outbox Row (QUEUED)                      |
+|                             '---> COMMIT ATOMICALLY                                |
+|                                          |                                        |
+|                                  [ Dispatch Outbox ]                              |
+|                                          | (Beat / Background Publisher)          |
+|                                          v                                        |
+|                                [ Celery Broker / Redis ]                          |
+|                                          |                                        |
+|                                   [ Celery Worker ]                               |
++-----------------------------------------------------------------------------------+
+```
+
+> [!IMPORTANT]
+> **Transactional Outbox Pattern**
+> Writing DB status and dispatching a Celery message in two separate steps creates a dual-write vulnerability. If a worker pod crashes right after committing to PostgreSQL but before sending the Celery message, the workflow dies. `celery-dag` writes dispatch payloads into a `dispatch_outbox` table within the **same SQL transaction**. The background Outbox Publisher guarantees at-least-once message delivery.
+
+> [!TIP]
+> **Edge-Based Dispatching vs. Level Barriers**
+> In a traditional `chord([A, B, C], D)`, `D` cannot start until *all* tasks finish. In `celery-dag`, dependency readiness is evaluated per edge. If `D` depends strictly on `A`, `D` executes the millisecond `A` finishes—even if `B` and `C` take another 30 minutes.
+
+---
+
+## 🔥 Feature Walkthrough
+
+### 1. Conditional Branching (`BranchResult`)
+Tasks can evaluate runtime business logic and select specific execution paths. Unselected branches automatically cascade downstream to `SKIPPED` state without hanging parent dependencies.
+
+```python
+from celery_dag import task_hub
+from celery_dag.core.branching import BranchResult
+
+@task_hub.register("evaluate_fraud_score")
+def evaluate_fraud_score(*, score: float) -> BranchResult:
+    if score > 80.0:
+        # Only 'manual_flag' executes; 'auto_approve' cascades to SKIPPED
+        return BranchResult(selected_nodes=["manual_flag"])
+    return BranchResult(selected_nodes=["auto_approve"])
+```
+
+### 2. Partial Rerun (`resume_from_failure`)
+If task #95 fails in a 100-task workflow (e.g. 5-second network timeout), you do not need to re-run the entire pipeline. `celery-dag` reuses intermediate cached outputs from PostgreSQL and object storage:
+
+```python
+executor = DAGExecutor()
+# Instantly resumes workflow from failed nodes; succeeded nodes are preserved
+executor.resume_from_failure(failed_run_id)
+```
+
+### 3. Payload Offloading (`ArtifactStore`)
+Task results exceeding `64 KB` are transparently offloaded to AWS S3, Google Cloud Storage, Azure Blob, or NFS:
+
+```python
+# PostgreSQL stores only a lightweight pointer JSON:
+# {"uri": "s3://my-bucket/artifacts/run_123/step_2.json", "size_bytes": 10485760}
+```
+
+### 4. Cooperative Cancellation (`CancellationToken`)
+Fast dual-layer cancellation combining Redis Pub/Sub signals and cached PostgreSQL tokens:
+
+```python
+@task_hub.register("heavy_ml_training")
+def heavy_ml_training(cancel_token: CancellationToken, **kwargs):
+    for epoch in range(100):
+        # Polls Redis in < 1ms; raises WorkflowCancelledError instantly
+        cancel_token.raise_if_cancelled()
+        train_epoch(epoch)
+```
+
+---
+
+## 📊 Comparison Matrix
+
+| Feature / Dimension | Default Celery Canvas (`chord` / `group`) | Apache Airflow | Temporal | **`celery-dag`** |
+| :--- | :--- | :--- | :--- | :--- |
+| **State Durability** | Ephemeral (Redis/AMQP) | DB Polling (Slow) | Event Sourced (Cassandra/DB) | **PostgreSQL (ACID)** |
+| **Dispatch Reliability** | Direct Celery publish (Dual-write risk) | Scheduler loop (~1 min delay) | High | **Transactional Outbox** |
+| **Fan-In Coordination** | Level-wide sync barrier (`chord`) | Task dependency state | Event history | **Edge-Based SQL Evaluation** |
+| **Partial Rerun / Resume** | ❌ No | ⚠️ Manual Clear | ✅ Yes | **✅ Yes (`resume_from_failure`)** |
+| **Dynamic Topology** | ❌ Fragile | ⚠️ Hard to manage | ✅ Yes | **✅ Native (`BranchResult`)** |
+| **Payload Offloading** | ❌ Redis Memory Bloat | ⚠️ XCom limits | ⚠️ Size limits | **✅ `ArtifactStore` (S3/GCS/Azure)** |
+| **Infrastructure Overhead** | Low | Heavy (Scheduler, Web, DB) | Very Heavy (Server, DB, Workers) | **Lightweight** (Embedded or Microservice) |
+
+---
+
+## 🌐 REST API & Observability
+
+`celery-dag` includes a standalone FastAPI microservice with interactive documentation and graph visualizers.
+
+```bash
+# Start REST API server
+uv run python main.py api
+```
+
+* **Swagger / OpenAPI Documentation**: `http://localhost:8000/docs`
+* **Live Graph Visualizer**: `GET /api/v1/workflows/{run_id}/visualization` (Returns Mermaid.js diagrams & Cytoscape graph payloads)
+* **KEDA / Prometheus Metrics**: `GET /api/v1/metrics` (Exposes queue lag, active workflows, and DLQ depth)
+
+---
+
+## ⚙️ Configuration Reference
+
+| Environment Variable | Default Value | Description |
+| :--- | :--- | :--- |
+| `DATABASE_URL` | `postgresql+psycopg://postgres:postgres@localhost:5432/celery_dag` | PostgreSQL connection string |
+| `REDIS_URL` | `redis://localhost:6379/0` | Redis broker & Pub/Sub URL |
+| `OUTBOX_MAX_PUBLISH_ATTEMPTS` | `5` | Retries before quarantining to Dead-Letter Queue (DLQ) |
+| `ARTIFACT_STORE_BACKEND` | `file` | Storage backend (`file`, `s3`, `gcs`, `azure`) |
+| `ARTIFACT_SIZE_THRESHOLD_BYTES` | `65536` | Payload size threshold (64 KB) triggering object storage offload |
+| `WORKFLOW_RETENTION_DAYS` | `30` | Automated retention sweeper window |
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read the [Contributing Guide](CONTRIBUTING.md) to set up your local development environment with `uv`, PostgreSQL, and Redis.
+
+* [Report a Bug](https://github.com/SantoshDhaladhuli/celery-dag/issues/new?template=bug_report.md)
+* [Request a Feature](https://github.com/SantoshDhaladhuli/celery-dag/issues/new?template=feature_request.md)
+* [Submit a Pull Request](https://github.com/SantoshDhaladhuli/celery-dag/pulls)
+
+---
+
+## 👤 Author & Maintainer
+
+Created and maintained by **Santosh Dhaladhuli**:
+* **GitHub**: [@SantoshDhaladhuli](https://github.com/SantoshDhaladhuli)
+* **Email**: [santoshsai666@gmail.com](mailto:santoshsai666@gmail.com)
+
+---
+
+## ⚖️ License
+
+Distributed under the **Apache License 2.0**. See [`LICENSE`](LICENSE) for details.