axl-workflows 0.1.0__tar.gz

axl_workflows-0.1.0/.gitignore

@@ -0,0 +1,31 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Build artifacts
+dist/
+build/
+*.egg-info/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Type checking
+.mypy_cache/
+
+# IDE
+.vscode/
+.idea/
+
+# OS
+.DS_Store
+Thumbs.db

axl_workflows-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

axl_workflows-0.1.0/MILESTONES.md

@@ -0,0 +1,224 @@
+# 📌 AXL Workflows (axl) — Milestones & Tasks
+
+---
+
+## **M0 — Project Bootstrap (uv-native)**
+
+**Goal:** Repo skeleton with uv, linting, CI, and minimal CLI.
+
+**Tasks**
+
+* [x] Init repo structure: `axl/`, `examples/`, `tests/`
+* [x] Create `pyproject.toml` (PEP 621 metadata, uv config, dev deps)
+* [x] Add `uv.lock` (committed)
+* [x] Setup dev workflow: `uv venv`, `uv sync --dev`, `uv run …`
+* [x] Pre-commit hooks: ruff, black, mypy
+* [x] GitHub Actions: setup-uv, cache, run ruff + mypy + pytest
+* [x] CLI stub: `axl --version` via Typer
+* [x] Base README.md with quickstart (params-as-step, pickle default)
+
+---
+
+## **M1 — DSL & IR MVP**
+
+**Goal:** Define workflows & inspect IR (with io metadata).
+
+**Tasks**
+
+* [x] Implement **`Workflow` base class** (defaults: image, default_io=pickle, input_mode_default, deps policy)
+* [x] Implement **`@workflow` decorator** (attribute overrides)
+* [x] Implement **`@step` decorator** with options:
+
+  * `io_handler` (default to pickle)
+  * `input_mode` = "object" | "path" | {arg: mode}
+  * `resources`, `retries`, `env`
+* [x] **Params-as-step pattern**: step calls inside `graph()` are symbolic (return `OutputRef`)
+* [x] Parse workflow class → **IR** (`IRWorkflow`, `IRNode`, `IREdge`, **output IO metadata**: handler name, file ext)
+* [x] Define **IOHandler protocol** + **`pickle_io_handler`** (save/load, metadata)
+* [x] CLI: `axl validate -m myflow:MyWorkflow` (build IR; basic checks)
+* [x] Unit tests for IR builder (nodes/edges, options captured)
+* [x] Type-check CI (`uv run mypy axl`)
+
+---
+
+## **M1.5 — Local Runtime & Release**
+
+**Goal:** Basic local execution and first PyPI release.
+
+**Tasks**
+
+* [x] **Local Runtime Engine**:
+  * Implement `axl/runtime/local.py` with step execution
+  * Topological sort and dependency resolution
+  * Artifact management with IO handlers
+  * Step method invocation and error handling
+* [x] **CLI Execution**:
+  * [x] `axl run local -m module:Class` command
+  * [x] Workflow instantiation
+  * [x] Parameter passing (`--params` YAML)
+  * [x] Progress reporting and logging
+* [x] **Runtime Tests**:
+  * [x] End-to-end workflow execution tests
+  * [x] Artifact save/load roundtrip tests
+  * [x] Error handling and recovery tests
+* [x] **Performance Improvements (completed)**:
+  * [x] IR indexing for `get_node()` O(1) lookups
+  * [x] Iterative IR traversal (builder) to avoid recursion limits
+* [ ] **Release Preparation**:
+  * Add PyPI metadata to `pyproject.toml` (name, version, license, classifiers)
+  * `uv build && uv run twine check dist/*`
+  * GitHub Actions: **tag-driven** release (OIDC trusted publisher)
+  * README "Install / Quickstart"
+
+➡️ **Release v0.1.0 (PyPI/TestPyPI)** 🎉
+
+* **DSL & IR**: Workflow definition, step decorators, IR building
+* **IO Handlers**: Pickle and cloudpickle serialization
+* **Local Runtime**: Basic workflow execution
+* **CLI**: Validation and local execution commands
+* **First PyPI Release**: Installable package
+
+---
+
+## **M1.6 — Performance & UX Improvements**
+
+**Goal:** Enhance performance and user experience with caching and better data handling.
+
+**Tasks**
+
+* [ ] **Workflow Hashing & Caching**:
+  * Add `blake3` dependency for fast hashing
+  * Implement `IRWorkflow.compute_hash()` method
+  * Hash-based workflow identification and caching
+  * CLI: show workflow hash for reproducibility
+* [ ] **Hash-based Artifact Storage**:
+  * LocalRuntime: optional `use_hash` flag
+  * Store artifacts under `workspace/{hash}/` structure
+  * Automatic cleanup of old workflow artifacts
+  * Hash-based artifact lookup and organization
+* [ ] **PyArrow/Parquet IO Handlers**:
+  * Add `pyarrow` as optional dependency
+  * Implement `ParquetIOHandler` for DataFrames
+  * Implement `ArrowIOHandler` for Arrow tables
+  * Automatic type detection and conversion
+  * Performance benchmarks and tests
+
+➡️ **Release v0.1.1**
+
+* **Performance**: Workflow caching and hash-based storage
+* **Data Handling**: PyArrow/Parquet support for ML workflows
+* **User Experience**: Better artifact organization and reproducibility
+* **Performance**: Faster data serialization and workflow execution
+
+---
+
+## **M2 — Argo Compiler**
+
+**Goal:** Compile IR → Argo Workflow YAML (KFP-compatible).
+
+**Tasks**
+
+* [ ] Implement `compiler.argo`:
+
+  * Templates/DAG
+  * Map **outputs to artifact files** with proper extensions
+  * Emit **IO manifest** (inputs/outputs with handler names/URIs)
+  * Respect `resources`, `retries`, future `when`
+* [ ] CLI: `axl compile --target argo --out out.yaml`
+* [ ] Golden-file tests for YAML
+* [ ] CI: run `argo lint` (if available)
+* [ ] Example workflow (`examples/churn_workflow.py`)
+
+➡️ **Release v0.2.0**
+
+* **Argo Compiler**: IR → Argo Workflow YAML
+* **KFP Compatibility**: Kubeflow Pipelines support
+* **Artifact Management**: IO manifest generation
+* **Production Ready**: Kubernetes deployment
+
+---
+
+## **M3 — Runner Container**
+
+**Goal:** Execute steps with uv-powered envs and io_handlers.
+
+**Tasks**
+
+* [ ] `Dockerfile.runner`: install uv; cache at `/opt/uv-cache`
+* [ ] Runner entrypoint (`axl.runtime.__main__`)
+
+  * Parse IO manifest & step args
+  * **Env setup**: create/reuse workflow venv (`uv sync` from lockfile/requirements)
+  * **Inputs**: load via handler (`object`) or pass **paths** per `input_mode`
+  * Invoke user function
+  * **Outputs**: save via handler (default pickle); write metadata
+* [ ] Artifact storage (PVC path; S3 later)
+* [ ] Logging: structured JSON
+* [ ] Local run: `axl run local -m module:Class`
+* [ ] E2E tests: object↔path modes, pickle roundtrip, failures
+
+➡️ **Release v0.3.0**
+
+* **Runner Container**: Docker-based step execution
+* **UV Integration**: Environment management with uv
+* **Artifact Storage**: PVC and S3 support
+* **Structured Logging**: JSON logs for observability
+* **Production Execution**: Containerized workflow runs
+
+---
+
+## **M4 — Dagster Compiler**
+
+**Goal:** Compile IR → Dagster ops & job for dev.
+
+**Tasks**
+
+* [ ] Implement `compiler.dagster` (ops, graph, job) that **invokes the runner** for uniform behavior
+* [ ] CLI: `axl compile --target dagster --out dagster_job.py`
+* [ ] Example job in `examples/`
+* [ ] Golden tests for generated code
+
+➡️ **Release v0.4.0**
+
+* **Dagster Compiler**: IR → Dagster ops and jobs
+* **Development Workflow**: Local Dagster execution
+* **Uniform Behavior**: Same runner across backends
+* **Developer Experience**: Rich Dagster UI integration
+
+---
+
+## **M5 — Dependency Management (uv-first) & Image Baking**
+
+**Goal:** Reproducible deps at workflow level; optional warm env; baked images for prod.
+
+**Tasks**
+
+* [ ] Workflow-level deps:
+
+  * `use_lockfile=True` (prefer `uv.lock`)
+  * `requirements=[...]` **or** `requirements_file="requirements.txt"` fallback
+* [ ] Optional **warm_env**: synthetic setup step to pre-build venv/cache
+* [ ] CLI: `axl build-image -m module:Class --tag ghcr.io/you/axl:0.x`
+
+  * Copy `pyproject.toml` + `uv.lock` / requirements
+  * `uv sync --frozen` at build time (no runtime installs in prod)
+* [ ] System packages only in baked images (no apt in runtime pods)
+* [ ] Examples: pandas+sklearn workflow; large deps
+
+➡️ **Release v0.5.0**
+
+* **Dependency Management**: UV-first workflow deps
+* **Image Baking**: Pre-built container images
+* **Reproducible Builds**: Lockfile and frozen deps
+* **Production Optimization**: No runtime installs
+* **Large Dependency Support**: Efficient caching
+
+---
+
+## **M6 — UX & Extras**
+
+**Goal:** Improve developer experience and observability.
+
+**Tasks**
+
+* [ ] `