orchestration-engine 0.9.0__tar.gz

orchestration_engine-0.9.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 union of 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

orchestration_engine-0.9.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Reddirector
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

orchestration_engine-0.9.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: orchestration-engine
+Version: 0.9.0
+Summary: A fault-tolerant workflow orchestration engine
+Keywords: workflow,orchestration,dag,scheduler,pipeline,agent,retry,task
+Author: Reddirector
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE
+License-File: LICENSE-MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: mkdocs>=1.6.0 ; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.5.0 ; extra == 'docs'
+Requires-Dist: pyyaml>=6.0 ; extra == 'yaml'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/Reddirector/Orchestration_Engine
+Project-URL: Repository, https://github.com/Reddirector/Orchestration_Engine
+Project-URL: Issues, https://github.com/Reddirector/Orchestration_Engine/issues
+Project-URL: Changelog, https://github.com/Reddirector/Orchestration_Engine/blob/main/CHANGELOG.md
+Provides-Extra: docs
+Provides-Extra: yaml
+Description-Content-Type: text/markdown
+
+# Orchestration-Engine
+
+A fault-tolerant workflow orchestration engine. Define tasks with dependencies, retry policies, and timeouts as JSON; the engine handles scheduling, execution ordering, retries with exponential backoff, timeouts, and state persistence — you supply the logic for each task.
+
+## Features
+
+- **Dependency-aware scheduling**: Tasks execute as soon as their upstream dependencies succeed.
+- **Configurable retries & exponential backoff**: Base delay doubles on each attempt (`delay_seconds * 2**(attempt_count - 1)`).
+- **Fault-tolerant exception handling**: Exceptions in task runners share the retry policy; `task.last_error` records error details.
+- **Enforced timeouts**: Per-task timeouts (default 30.0s) enforced asynchronously without blocking the engine coordinator.
+- **Transitive cancellation**: When a task fails permanently, all downstream dependents are cancelled to a fixpoint.
+- **SQLite-backed audit trail**: Append-only event log with write-ahead persistence of state transitions.
+- **Zero runtime dependencies**: Pure Python standard library implementation.
+
+## Installation
+
+Not yet published to PyPI. Install directly from source for now:
+
+```bash
+pip install git+https://github.com/Reddirector/Orchestration_Engine.git
+```
+
+## Quickstart
+
+Define a workflow as JSON — two tasks, the second depending on the first:
+
+```json
+{
+  "workflow_id": "wf-1",
+  "name": "example-workflow",
+  "description": "A minimal two-task workflow",
+  "default_timeout_seconds": 30.0,
+  "tasks": [
+    {
+      "task_id": "fetch-data",
+      "name": "Fetch data",
+      "description": "Pulls input data",
+      "dependencies": [],
+      "retry_policy": { "max_attempts": 3, "delay_seconds": 1.0 },
+      "timeout_seconds": 15.0
+    },
+    {
+      "task_id": "process-data",
+      "name": "Process data",
+      "description": "Processes the fetched data",
+      "dependencies": ["fetch-data"],
+      "retry_policy": { "max_attempts": 3, "delay_seconds": 2.0 },
+      "timeout_seconds": 30.0
+    }
+  ]
+}
+```
+
+Run it:
+
+```python
+import time
+from orchestration_engine import get_connection, run_workflow_from_file
+
+def task_runner(task) -> bool:
+    print(f"Running task: {task.name}")
+    # Return True on success, False on failure (triggers retry per the task's retry_policy).
+    # Unhandled exceptions are also caught and retried per policy.
+    return True
+
+conn = get_connection("my_workflows.db")  # or ":memory:"
+status = run_workflow_from_file("workflow.json", task_runner, time.time, conn)
+print(status)  # WorkflowStatus.SUCCEEDED
+```
+
+## Command-Line Interface (CLI)
+
+`orchestration-engine` includes a full-featured CLI for validating, executing, and inspecting workflows directly from the terminal:
+
+```bash
+# Validate workflow definition
+orchestration-engine validate examples/simple_workflow.json
+
+# Run workflow with an SQLite database
+orchestration-engine run examples/simple_workflow.json --runner examples.runners:run --db workflows.db
+
+# Inspect run status, transition history, and run list
+orchestration-engine status <run_id> --db workflows.db
+orchestration-engine history <run_id> --db workflows.db
+orchestration-engine runs --db workflows.db
+```
+
+For full CLI documentation, exit codes, and JSON schemas, see [docs/cli.md](docs/cli.md).
+
+## Durability and Crash Recovery
+
+Every execution is tracked as a distinct run with an explicit or automatically generated `run_id`:
+
+```python
+import time
+from orchestration_engine import get_connection, run_workflow, resume_run, get_run_status, list_runs
+
+conn = get_connection("workflows.db")
+
+# Run a workflow and obtain its run_id
+run_id = run_workflow(workflow, {}, time.time, task_runner, conn)
+
+# Query run status directly from SQLite
+status = get_run_status(conn, run_id)
+
+# List all recorded runs
+runs = list_runs(conn, workflow_id="wf-1")
+
+# If a process was interrupted or crashed (e.g. host reboot, SIGKILL), resume it:
+resumed_status = resume_run(conn, run_id, task_runner, time.time)
+# Completed tasks are never re-run; interrupted tasks are retried per policy.
+```
+
+## Concurrency
+
+Tasks can be executed concurrently up to `max_concurrency` using either threads or spawned child processes:
+
+```python
+# Run with up to 4 parallel workers using threads
+run_id = run_workflow(
+    workflow,
+    task_states,
+    time.time,
+    task_runner,
+    conn,
+    max_concurrency=4,
+    executor="thread",
+)
+
+# Run with isolated child processes
+run_id = run_workflow(
+    workflow,
+    task_states,
+    time.time,
+    task_runner,
+    conn,
+    max_concurrency=4,
+    executor="process",
+)
+```
+
+### Architecture: Single-Writer Coordinator
+- **Safety**: The main coordinator thread calling `run_workflow` retains exclusive access to SQLite and performs all state transitions. No database connections are ever shared across threads or processes, completely eliminating `sqlite3.ProgrammingError` or database contention.
+- **Thread Backend (`executor="thread"`)**: Lightweight concurrency using `concurrent.futures.ThreadPoolExecutor`. Note that Python threads cannot be preemptively killed; a timed-out task is abandoned by the coordinator and marked failed/retried, while its thread runs to completion in the background.
+- **Process Backend (`executor="process"`)**: True process isolation using `multiprocessing.get_context("spawn")`. On timeout, child processes are terminated with `SIGTERM` and killed with `SIGKILL` after a short grace period. Requires `task_runner` to be picklable.
+
+## Data Flow and Outputs
+
+Tasks can return a `TaskResult(ok=True, output=...)` to pass data to downstream dependents:
+
+```python
+from orchestration_engine import TaskResult
+
+def task_runner(task):
+    if task.task_id == "fetch_user":
+        return TaskResult(ok=True, output={"user_id": 42, "name": "Alice"})
+    elif task.task_id == "greet":
+        # Upstream outputs are automatically injected into task.inputs
+        user = task.inputs["fetch_user"]
+        return TaskResult(ok=True, output=f"Hello, {user['name']}!")
+    return TaskResult(ok=True)
+```
+
+Outputs are persisted in SQLite under Schema v2 and automatically restored upon workflow resumption.
+
+## Lifecycle Hooks
+
+Observe workflow and task state changes safely:
+
+```python
+from orchestration_engine import Hooks
+
+hooks = Hooks(
+    on_task_start=lambda task: print(f"Started: {task.name}"),
+    on_task_succeeded=lambda task: print(f"Succeeded: {task.name}"),
+    on_task_retry=lambda task: print(f"Retrying: {task.name}"),
+    on_task_failed=lambda task: print(f"Failed: {task.name}"),
+    on_workflow_done=lambda wf, status: print(f"Finished: {status.value}"),
+)
+
+run_workflow(workflow, {}, time.time, task_runner, conn, hooks=hooks)
+```
+
+Hooks execute *after* state transitions are persisted to SQLite. Any exception raised inside a hook is caught and suppressed to prevent user hook bugs from interrupting workflow execution.
+
+## Fluent Workflow Builder
+
+Construct and validate workflows with a fluent chaining API:
+
+```python
+from orchestration_engine import WorkflowBuilder, workflow_to_dict
+
+workflow = (
+    WorkflowBuilder("etl-wf", "ETL Pipeline")
+    .description("Extract, transform, and load data")
+    .default_timeout(60.0)
+    .task("extract", name="Extract Records")
+    .task("transform", name="Transform Records", dependencies=["extract"], max_attempts=3)
+    .task("load", name="Load to DB", dependencies=["transform"])
+    .build()
+)
+
+# Losslessly serialize to JSON dictionary:
+wf_dict = workflow_to_dict(workflow)
+```
+
+## Real-World Use Cases
+
+The repository includes runnable simulated pipeline examples (using clean stubs with zero external SDK dependencies) in `examples/`:
+
+- **[Multi-Step AI Agent Pipeline](examples/agent_pipeline.py)**: Orchestrates LLM tool calling, document retrieval, automated retries on transient API rate limits (`HTTP 429`), concurrent entity extraction, and fan-in executive summary synthesis.
+- **[RAG Knowledge Ingestion & Vector Indexing](examples/rag_document_indexer.py)**: Semantic document chunking, parallel embedding generation with transient backpressure handling, vector store upsert, and an automated quality evaluation gate.
+- **[Autonomous Incident Triage & Remediation](examples/incident_triage.py)**: SRE incident response workflow running parallel diagnostics across logs, metrics, and service dependencies (`max_concurrency=3`), synthesizing root cause analysis (RCA), executing automated remediation, and verifying health recovery.
+- **[Resilient Data Flow & ETL](examples/data_flow.py)**: Producer-consumer data flow where task outputs pass cleanly downstream via `task.inputs` with full transactional persistence.
+
+See the complete [Use Cases Documentation](docs/use-cases.md) for architectural diagrams and deep dives.
+
+## Public API
+
+| Name | Purpose |
+| --- | --- |
+| `Task`, `Workflow` | Core data models |
+| `TaskResult` | Result returned by task runners containing `output` and `error` |
+| `Hooks` | Post-persistence lifecycle event callbacks |
+| `WorkflowBuilder` | Fluent builder for creating and validating workflows |
+| `workflow_to_dict` | Serialize a `Workflow` into a JSON-compatible dict |
+| `RetryPolicy` | Per-task retry configuration (max_attempts, delay_seconds) |
+| `TaskState`, `WorkflowStatus` | State enums (`PENDING`, `READY`, `RUNNING`, `RETRY_WAIT`, `SUCCEEDED`, `FAILED`, `CANCELLED`) |
+| `run_workflow` | Run an already-constructed `Workflow`; returns `run_id` |
+| `run_workflow_from_file` | Load a JSON workflow file and run it end-to-end |
+| `resume_run` | Resume an interrupted workflow run from SQLite |
+| `load_workflow_from_json` | Parse JSON dict into a `Workflow` (with optional `collect_errors=True`) |
+| `load_workflow_from_yaml` | Parse YAML workflow definition (requires `orchestration-engine[yaml]`) |
+| `get_workflow_status` | Get a workflow's in-memory overall lifecycle status |
+| `get_run_status` | Get run status derived directly from SQLite events |
+| `get_workflow_history` | Retrieve ordered event log tuples for a workflow |
+| `get_run_history` | Retrieve ordered event log tuples for a specific run |
+| `list_runs` | List recorded runs newest first (optionally by workflow_id) |
+| `get_connection` | Get or initialize SQLite connection with WAL & migrations |
+| `OrchestrationError` | Base exception for all engine errors |
+| `WorkflowDefinitionError` | Raised on malformed workflow definitions (subclasses `ValueError`) |
+| `WorkflowValidationError` | Raised on invalid workflow DAG structure (subclasses `ValueError`) |
+| `PersistenceError` | Raised when persistence operations fail (wraps `sqlite3.Error`) |
+
+## Authorship & Development
+
+The v0.1 core was hand-crafted; Stages 2–7 were developed via autonomous AI agent pairing with human code review and strict automated quality gates.
+
+## License
+
+Dual-licensed under either MIT or Apache 2.0 at your option — see [LICENSE-MIT](LICENSE-MIT) and [LICENSE](LICENSE).