reci 0.0.2__tar.gz

reci-0.0.2/.gitattributes

@@ -0,0 +1 @@
+*.ipynb linguist-documentation

reci-0.0.2/.github/workflows/ci.yml

@@ -0,0 +1,256 @@
+name: Continuous Integration (uv)
+on: [push, pull_request]
+
+# Note: Environment variables (PROJECT_NAME and vars from [tool.wads.ci.env])
+# are set by the read-ci-config action in the setup job and made available
+# to all subsequent jobs via GITHUB_ENV
+
+jobs:
+  # First job: Read configuration from pyproject.toml
+  setup:
+    name: Read Configuration
+    runs-on: ubuntu-latest
+    outputs:
+      project-name: ${{ steps.config.outputs.project-name }}
+      python-versions: ${{ steps.config.outputs.python-versions }}
+      pytest-args: ${{ steps.config.outputs.pytest-args }}
+      coverage-enabled: ${{ steps.config.outputs.coverage-enabled }}
+      exclude-paths: ${{ steps.config.outputs.exclude-paths }}
+      test-on-windows: ${{ steps.config.outputs.test-on-windows }}
+      build-sdist: ${{ steps.config.outputs.build-sdist }}
+      build-wheel: ${{ steps.config.outputs.build-wheel }}
+      metrics-enabled: ${{ steps.config.outputs.metrics-enabled }}
+      metrics-config-path: ${{ steps.config.outputs.metrics-config-path }}
+      metrics-storage-branch: ${{ steps.config.outputs.metrics-storage-branch }}
+      metrics-python-version: ${{ steps.config.outputs.metrics-python-version }}
+      metrics-force-run: ${{ steps.config.outputs.metrics-force-run }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Read CI Config
+        id: config
+        uses: i2mint/wads/actions/read-ci-config@master
+        with:
+          pyproject-path: .
+
+  # Second job: Validation using the config
+  validation:
+    name: Validation
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ${{ fromJson(needs.setup.outputs.python-versions) }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: |
+          uv python install ${{ matrix.python-version }}
+          uv venv --python ${{ matrix.python-version }}
+
+      - name: Install System Dependencies
+        uses: i2mint/wads/actions/install-system-deps@master
+        with:
+          pyproject-path: .
+
+      - name: Install Dependencies
+        run: |
+          source .venv/bin/activate
+          uv pip install -e ".[dev]"
+
+      - name: Format Source Code
+        run: uvx ruff format .
+
+      - name: Lint Validation
+        run: uvx ruff check --output-format=github ${{ needs.setup.outputs.project-name }}
+
+      - name: Run Tests
+        run: |
+          source .venv/bin/activate
+          PYTEST_ARGS="${{ needs.setup.outputs.pytest-args }}"
+          EXCLUDE="${{ needs.setup.outputs.exclude-paths }}"
+          COVERAGE="${{ needs.setup.outputs.coverage-enabled }}"
+          ROOT_DIR="${{ needs.setup.outputs.project-name }}"
+
+          CMD="python -m pytest"
+
+          # Add coverage flags
+          if [ "$COVERAGE" = "true" ]; then
+            uv pip install pytest-cov
+            CMD="$CMD --cov=$ROOT_DIR --cov-report=term-missing"
+          fi
+
+          # Add doctest flags
+          CMD="$CMD --doctest-modules"
+          CMD="$CMD -o doctest_optionflags='ELLIPSIS IGNORE_EXCEPTION_DETAIL'"
+
+          # Add exclude paths
+          if [ -n "$EXCLUDE" ]; then
+            IFS=',' read -ra PATHS <<< "$EXCLUDE"
+            for path in "${PATHS[@]}"; do
+              path=$(echo "$path" | xargs)
+              CMD="$CMD --ignore=$path"
+            done
+          fi
+
+          # Add extra pytest args
+          if [ -n "$PYTEST_ARGS" ]; then
+            CMD="$CMD $PYTEST_ARGS"
+          fi
+
+          echo "Running: $CMD"
+          eval $CMD
+
+      - name: Track Code Metrics
+        if: needs.setup.outputs.metrics-enabled == 'true'
+        uses: i2mint/umpyre/actions/track-metrics@master
+        continue-on-error: true
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          config-path: ${{ needs.setup.outputs.metrics-config-path }}
+          storage-branch: ${{ needs.setup.outputs.metrics-storage-branch }}
+          python-version: ${{ needs.setup.outputs.metrics-python-version }}
+          force-run: ${{ needs.setup.outputs.metrics-force-run }}
+
+  # Optional Windows testing (if enabled in config)
+  windows-validation:
+    name: Windows Tests
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && needs.setup.outputs.test-on-windows == 'true'"
+    needs: setup
+    runs-on: windows-latest
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: |
+          uv python install ${{ fromJson(needs.setup.outputs.python-versions)[0] }}
+          uv venv
+
+      - name: Install System Dependencies
+        uses: i2mint/wads/actions/install-system-deps@master
+        with:
+          pyproject-path: .
+
+      - name: Install Dependencies
+        run: |
+          .venv\Scripts\activate
+          uv pip install -e ".[dev]"
+
+      - name: Run tests
+        id: test
+        continue-on-error: true
+        run: |
+          .venv\Scripts\activate
+          pytest
+
+      - name: Report test results
+        if: always()
+        run: |
+          if ("${{ steps.test.outcome }}" -eq "failure") {
+            echo "::warning::Windows tests failed but workflow continues"
+            echo "## ⚠️ Windows Tests Failed" >> $env:GITHUB_STEP_SUMMARY
+            echo "Tests failed on Windows but this is informational only." >> $env:GITHUB_STEP_SUMMARY
+          } else {
+            echo "## ✅ Windows Tests Passed" >> $env:GITHUB_STEP_SUMMARY
+          }
+
+  # Publishing job
+  publish:
+    name: Publish
+    permissions:
+      contents: write
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main')"
+    needs: [setup, validation]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install ${{ fromJson(needs.setup.outputs.python-versions)[0] }}
+
+      - name: Format Source Code
+        run: uvx ruff format .
+
+      - name: Update Version Number
+        id: version
+        uses: i2mint/isee/actions/bump-version-number@master
+
+      - name: Build Distribution
+        run: |
+          BUILD_ARGS=""
+          if [ "${{ needs.setup.outputs.build-sdist }}" = "false" ]; then
+            BUILD_ARGS="$BUILD_ARGS --no-sdist"
+          fi
+          if [ "${{ needs.setup.outputs.build-wheel }}" = "false" ]; then
+            BUILD_ARGS="$BUILD_ARGS --no-wheel"
+          fi
+          uv build $BUILD_ARGS
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_PASSWORD }}
+        run: uv publish dist/*
+
+      - name: Force SSH for git remote
+        run: |
+          git remote set-url origin git@github.com:${{ github.repository }}.git
+
+      - name: Commit Changes
+        uses: i2mint/wads/actions/git-commit@master
+        with:
+          commit-message: "**CI** Formatted code + Updated version to ${{ env.VERSION }} [skip ci]"
+          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+          push: true
+
+      - name: Tag Repository
+        uses: i2mint/wads/actions/git-tag@master
+        with:
+          tag: ${{ env.VERSION }}
+          message: "Release version ${{ env.VERSION }}"
+          push: true
+
+  # Optional GitHub Pages
+  github-pages:
+    name: Publish GitHub Pages
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)"
+    needs: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: i2mint/epythet/actions/publish-github-pages@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          ignore: "tests/,scrap/,examples/"

reci-0.0.2/.gitignore

@@ -0,0 +1,121 @@
+wads_configs.json
+data/wads_configs.json
+wads/data/wads_configs.json
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+
+.DS_Store
+# C extensions
+*.so
+
+# TLS certificates
+## Ignore all PEM files anywhere
+*.pem
+## Also ignore any certs directory
+certs/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+_build
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/*
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# PyCharm
+.idea

reci-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thor Whalen
+
+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.

reci-0.0.2/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: reci
+Version: 0.0.2
+Summary: Compile declarative CI recipes into fully-wired GitHub Actions workflows with typed data-flow validation.
+Project-URL: Homepage, https://github.com/i2mint/reci
+Project-URL: Repository, https://github.com/i2mint/reci
+Project-URL: Documentation, https://i2mint.github.io/reci
+Author: Thor Whalen
+License: mit
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: argh>=0.31
+Requires-Dist: httpx>=0.27
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Dist: tomlkit>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'docs'
+Requires-Dist: sphinx>=6.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+
+# reci
+
+Compile declarative CI recipes into fully-wired GitHub Actions workflows with typed data-flow validation.
+
+To install:	```pip install reci```
+
+## What it does
+
+Write a short recipe YAML describing your CI pipeline as a DAG of GitHub Actions.
+`reci` introspects each action's `action.yml` for typed input/output contracts,
+infers data-flow edges from variable names, injects config from `pyproject.toml`,
+and compiles the whole thing into a complete workflow YAML — with all the
+cross-job output wiring generated for you.
+
+## Quick start
+
+```python
+from reci import parse_recipe_string, compile_recipe, dump_workflow, ActionSpec, InputSpec, OutputSpec
+
+recipe = parse_recipe_string("""
+name: CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '${{ config.python_version }}'
+      - id: run_tests
+        run: pytest
+""")
+
+# Action specs can be fetched from GitHub or provided manually
+specs = {
+    "actions/checkout@v4": ActionSpec(ref="actions/checkout@v4"),
+    "actions/setup-python@v5": ActionSpec(
+        ref="actions/setup-python@v5",
+        inputs={"python_version": InputSpec(name="python_version", default="3.x")},
+    ),
+}
+
+config = {"python_version": "3.12"}
+workflow = compile_recipe(recipe, specs, config=config)
+print(dump_workflow(workflow))
+```
+
+The compiler:
+- Injects a `setup` job that exports config values as job outputs
+- Rewrites `${{ config.* }}` to `${{ needs.setup.outputs.* }}`
+- Auto-wires `needs:` edges from data-flow dependencies
+- Generates the cross-job output forwarding ceremony (step output -> job output -> `needs` consumption)
+
+## CLI
+
+```bash
+# Inspect an action's input/output contract
+reci inspect actions/setup-python@v5
+
+# Compile a recipe to workflow YAML
+reci compile recipe.yml --output .github/workflows/ci.yml
+
+# Validate a recipe + config
+reci validate --recipe recipe.yml --format cli
+
+# Scaffold a config skeleton from a recipe
+reci scaffold recipe.yml
+```
+
+## Five-level input resolution
+
+For each action input, the compiler resolves its value using this precedence:
+
+1. **Explicit `with:`** in the recipe — used verbatim
+2. **Upstream output match** — `${{ steps.<id>.outputs.<name> }}`
+3. **Config value** (scoped `action__key`, then shared `key`) — `${{ needs.setup.outputs.<key> }}`
+4. **Default from action.yml** — omitted (GitHub uses the default)
+5. **Required + no source** — validation error
+
+## Validation
+
+ESLint-style severity (`error`/`warning`/`info`) with ruff-style rule prefixes:
+
+| Rule | Category | What it catches |
+|------|----------|----------------|
+| DAG001 | Structure | Cycle detected |
+| DAG002 | Structure | Duplicate output name in a job |
+| FLOW001 | Data flow | Required input has no source |
+| FLOW002 | Data flow | Ambiguous wiring (multiple upstream matches) |
+| FLOW006 | Data flow | Matrix job output consumed downstream (non-deterministic) |
+| CONF001 | Config | Required config key missing |
+| PURE001 | Purity | `run:` step breaks typed contract |
+| ACT002 | Action | Referenced action not found |
+
+## Config adapters
+
+Read CI config from your project file of choice:
+
+| Adapter | Section | Library |
+|---------|---------|---------|
+| `pyproject` | `[tool.ci]` | tomlkit (round-trip) |
+| `wads` | `[tool.wads.ci]` | tomlkit |
+| `package-json` | `"ci"` key | json |
+| `yaml` | `.ci.yml` | ruamel.yaml |
+
+## The recipe format
+
+A recipe looks like a GitHub Actions workflow with reci extensions:
+
+- **`${{ config.* }}`** — references to config values (resolved from pyproject.toml etc.)
+- **`bind:`** — input renaming (`bind: {tag_name: version}` wires upstream output `version` to input `tag_name`)
+- **`outputs:`** on `run:` steps — manual output annotation for untyped steps
+
+```yaml
+name: Python CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '${{ config.python_version }}'
+      - run: pytest
+
+  publish:
+    needs: [test]
+    steps:
+      - uses: actions/checkout@v4
+      - id: bump
+        uses: i2mint/isee/actions/bump-version-number@master
+      - uses: i2mint/wads/actions/git-tag@master
+        bind:
+          tag_name: version  # wire bump's "version" output to git-tag's "tag_name" input
+```

reci-0.0.2/README.md

@@ -0,0 +1,138 @@
+
+# reci
+
+Compile declarative CI recipes into fully-wired GitHub Actions workflows with typed data-flow validation.
+
+To install:	```pip install reci```
+
+## What it does
+
+Write a short recipe YAML describing your CI pipeline as a DAG of GitHub Actions.
+`reci` introspects each action's `action.yml` for typed input/output contracts,
+infers data-flow edges from variable names, injects config from `pyproject.toml`,
+and compiles the whole thing into a complete workflow YAML — with all the
+cross-job output wiring generated for you.
+
+## Quick start
+
+```python
+from reci import parse_recipe_string, compile_recipe, dump_workflow, ActionSpec, InputSpec, OutputSpec
+
+recipe = parse_recipe_string("""
+name: CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '${{ config.python_version }}'
+      - id: run_tests
+        run: pytest
+""")
+
+# Action specs can be fetched from GitHub or provided manually
+specs = {
+    "actions/checkout@v4": ActionSpec(ref="actions/checkout@v4"),
+    "actions/setup-python@v5": ActionSpec(
+        ref="actions/setup-python@v5",
+        inputs={"python_version": InputSpec(name="python_version", default="3.x")},
+    ),
+}
+
+config = {"python_version": "3.12"}
+workflow = compile_recipe(recipe, specs, config=config)
+print(dump_workflow(workflow))
+```
+
+The compiler:
+- Injects a `setup` job that exports config values as job outputs
+- Rewrites `${{ config.* }}` to `${{ needs.setup.outputs.* }}`
+- Auto-wires `needs:` edges from data-flow dependencies
+- Generates the cross-job output forwarding ceremony (step output -> job output -> `needs` consumption)
+
+## CLI
+
+```bash
+# Inspect an action's input/output contract
+reci inspect actions/setup-python@v5
+
+# Compile a recipe to workflow YAML
+reci compile recipe.yml --output .github/workflows/ci.yml
+
+# Validate a recipe + config
+reci validate --recipe recipe.yml --format cli
+
+# Scaffold a config skeleton from a recipe
+reci scaffold recipe.yml
+```
+
+## Five-level input resolution
+
+For each action input, the compiler resolves its value using this precedence:
+
+1. **Explicit `with:`** in the recipe — used verbatim
+2. **Upstream output match** — `${{ steps.<id>.outputs.<name> }}`
+3. **Config value** (scoped `action__key`, then shared `key`) — `${{ needs.setup.outputs.<key> }}`
+4. **Default from action.yml** — omitted (GitHub uses the default)
+5. **Required + no source** — validation error
+
+## Validation
+
+ESLint-style severity (`error`/`warning`/`info`) with ruff-style rule prefixes:
+
+| Rule | Category | What it catches |
+|------|----------|----------------|
+| DAG001 | Structure | Cycle detected |
+| DAG002 | Structure | Duplicate output name in a job |
+| FLOW001 | Data flow | Required input has no source |
+| FLOW002 | Data flow | Ambiguous wiring (multiple upstream matches) |
+| FLOW006 | Data flow | Matrix job output consumed downstream (non-deterministic) |
+| CONF001 | Config | Required config key missing |
+| PURE001 | Purity | `run:` step breaks typed contract |
+| ACT002 | Action | Referenced action not found |
+
+## Config adapters
+
+Read CI config from your project file of choice:
+
+| Adapter | Section | Library |
+|---------|---------|---------|
+| `pyproject` | `[tool.ci]` | tomlkit (round-trip) |
+| `wads` | `[tool.wads.ci]` | tomlkit |
+| `package-json` | `"ci"` key | json |
+| `yaml` | `.ci.yml` | ruamel.yaml |
+
+## The recipe format
+
+A recipe looks like a GitHub Actions workflow with reci extensions:
+
+- **`${{ config.* }}`** — references to config values (resolved from pyproject.toml etc.)
+- **`bind:`** — input renaming (`bind: {tag_name: version}` wires upstream output `version` to input `tag_name`)
+- **`outputs:`** on `run:` steps — manual output annotation for untyped steps
+
+```yaml
+name: Python CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '${{ config.python_version }}'
+      - run: pytest
+
+  publish:
+    needs: [test]
+    steps:
+      - uses: actions/checkout@v4
+      - id: bump
+        uses: i2mint/isee/actions/bump-version-number@master
+      - uses: i2mint/wads/actions/git-tag@master
+        bind:
+          tag_name: version  # wire bump's "version" output to git-tag's "tag_name" input
+```