decider 0.0.1__tar.gz

decider-0.0.1/.dockerignore

@@ -0,0 +1,25 @@
+# Ignore everything then whitelist what the image actually needs
+*
+
+# Package source and build artefacts
+!/decider
+!/dist
+!/pyproject.toml
+!/uv.lock
+
+# Strip noise from allowed directories
+**/__pycache__
+**/*.pyc
+**/*.pyo
+**/*.pyd
+**/*.egg-info
+**/.DS_Store
+**/Thumbs.db
+**/*.log
+**/.git
+**/.mypy_cache
+**/.pytest_cache
+**/.hypothesis
+**/.coverage
+**/.coverage.*
+**/.tox

decider-0.0.1/.gitattributes

@@ -0,0 +1,5 @@
+# Ensure consistent line endings
+* text=auto
+
+# Mark generated version file so it survives `git archive --export-subst`
+decider/_version.py export-subst

decider-0.0.1/.github/workflows/pr.yml

@@ -0,0 +1,31 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run tests
+        run: uv run pytest

decider-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,220 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]*'
+
+env:
+  DOCKER_IMAGE: capitecbankltd/decider
+
+jobs:
+  # ── 1. Resolve version from git tags (hatch-vcs) ──────────────────────────
+  version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0          # full history so hatch-vcs can read tags
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Resolve version
+        id: get
+        run: |
+          uv sync --group dev
+          VERSION=$(uv run python -c "from importlib.metadata import version; print(version('decider'))")
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+
+  # ── 2a. Build wheel → PyPI ─────────────────────────────────────────────────
+  publish-pypi:
+    needs: version
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/p/decider
+    permissions:
+      id-token: write     # OIDC trusted publishing — no token secret needed
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Run tests
+        run: |
+          uv sync --group dev
+          uv run pytest
+
+      - name: Build wheel + sdist
+        run: uv build
+
+      - name: Upload wheel artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 1
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+
+  # ── 2b. Build and push Docker image ───────────────────────────────────────
+  publish-docker:
+    needs: [version, publish-pypi]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download wheel artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push versioned image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: true
+          tags: ${{ env.DOCKER_IMAGE }}:${{ needs.version.outputs.version }}
+          cache-from: type=gha
+          cache-to:   type=gha,mode=max
+
+      - name: Re-tag as latest
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: true
+          tags: ${{ env.DOCKER_IMAGE }}:latest
+          cache-from: type=gha
+
+  # ── 2c. Build and deploy versioned docs to GitHub Pages ───────────────────
+  publish-docs:
+    needs: version
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://capitecbankltd.github.io/dsp_north-polrs
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: uv sync --extra docs
+
+      - name: Restore previous gh-pages (for versioned history)
+        # Pull whatever is already deployed so we can layer this release on top.
+        # If the branch doesn't exist yet the step silently skips.
+        run: |
+          git fetch origin gh-pages:gh-pages 2>/dev/null || true
+          if git show-ref --quiet refs/heads/gh-pages; then
+            git worktree add _site gh-pages
+          else
+            mkdir -p _site
+          fi
+
+      - name: Build docs for this version
+        env:
+          VERSION: ${{ needs.version.outputs.version }}
+        run: |
+          uv run python -m sphinx docs docs/_build/html -b html
+          # Copy into a versioned subdirectory so older releases stay accessible.
+          mkdir -p _site/$VERSION
+          cp -r docs/_build/html/. _site/$VERSION/
+          # Also update the root (latest) copy.
+          cp -r docs/_build/html/. _site/
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site/
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4
+
+  # ── 3. Tag and create GitHub Release (after all three deploys succeed) ─────
+  github-release:
+    needs: [version, publish-pypi, publish-docker, publish-docs]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download wheel artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Push version tag
+        env:
+          VERSION: ${{ needs.version.outputs.version }}
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name  "github-actions[bot]"
+          # Skip if tag already exists (e.g. re-run on same commit).
+          git tag "v${VERSION}" || true
+          git push origin "v${VERSION}" || true
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: v${{ needs.version.outputs.version }}
+          name:     Release ${{ needs.version.outputs.version }}
+          generate_release_notes: true
+          files: dist/*

decider-0.0.1/.gitignore

@@ -0,0 +1,180 @@
+# Template used from https://github.com/github/gitignore/blob/main/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/_autosummary/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# General
+.DS_Store
+
+.vscode
+.claude
+
+# uv
+# uv.lock is committed for reproducible installs — do not ignore it
+.python-version
+
+# hatch-vcs generated version file
+decider/_version.py
+
+# project-level extension configs (generated by decider_extensions)
+projects/*/configs/

decider-0.0.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+opensource@capitecbank.co.za.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

decider-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# Contributing
+
+We value and encourage community contributions. To get started, please follow these guidelines:
+
+1. [Code of Conduct](#1-code-of-conduct)
+2. [Issues](#2-issues)
+3. [Vulnerabilities](#3-vulnerabilities)
+4. [Development](#4-development)
+5. [Pull Requests](#5-pull-requests)
+
+## 1. Code of Conduct
+
+Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## 2. Issues
+
+Engagement starts with an Issue where conversations and debates can occur around [bugs](#bugs) and [feature requests](#feature-requests):
+
+- ✅ **Do** search for a similar or existing Issue prior to submitting a new one.
+- ❌ **Do not** use Issues for personal support. Use [Discussions](https://github.com/capitecbankltd/dsp_north-polrs/discussions) or [StackOverflow](https://stackoverflow.com/) instead.
+- ❌ **Do not** side-track or derail Issue threads. Stick to the topic, please.
+- ❌ **Do not** post comments using just "+1", "++" or "👍". Use [Reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) instead.
+
+<h3 id="bugs">👾 Bugs</h3>
+
+- ✅ **Do** search for a similar or existing Issue prior to submitting a new one.
+- ✅ **Do** describe the bug concisely. **Avoid** adding extraneous code, logs, or screenshots.
+- ✅ **Do** attach a minimal test or example to demonstrate the bug.
+
+<h3 id="feature-requests">💡 Feature Requests</h3>
+
+- ✅ **Do** search for a similar or existing Issue prior to submitting a new one.
+- ✅ **Do** provide sufficient motivation and use case(s) for the feature.
+- ❌ **Do not** submit multiple unrelated requests within one request.
+
+> **TIP:** Engage as much as possible within an Issue before proceeding with contributions.
+
+## 3. Vulnerabilities
+
+- ✅ **Do** refer to our [Security Policy](https://github.com/capitecbankltd/dsp_north-polrs/security/policy) for more information.
+- ✅ **Do** report vulnerabilities via this [link](https://github.com/capitec/ml-decision-engine/security/advisories/new).
+- ❌ **Do not** open a public Issue or Discussion for security vulnerabilities.
+
+## 4. Development
+
+<h3 id="branches">🌱 Branches</h3>
+
+- `feature/*` — feature development; PR target is `main`.
+- `main` — stable branch; tagged releases are cut from here.
+
+<h3 id="dependencies">🔒 Dependencies</h3>
+
+- Python >= 3.10
+- [uv](https://docs.astral.sh/uv/) for environment and dependency management.
+
+<h3 id="project-setup">📦 Project Setup</h3>
+
+```bash
+# 1. Clone and enter the repo
+git clone https://github.com/capitecbankltd/dsp_north-polrs.git
+cd dsp_north-polrs
+
+# 2. Install all dependencies (creates .venv automatically)
+uv sync --all-extras
+
+# 3. Run the tests
+uv run pytest
+```
+
+If you are behind a corporate proxy that uses a private CA, `uv` is already
+configured to use the system certificate store (`system-certs = true` in
+`pyproject.toml`).
+
+<h3 id="directory-structure">📂 Directory Structure</h3>
+
+```
+decider/                  Core library
+  cli/                    `decider` CLI (click)
+  config/                 Versioned config management
+  modules/                Module primitives (expression, join, sequential, union)
+  serving/                HTTP servers (Starlette, Sanic)
+  templates/              Scaffolding templates and scaffold.py renderer
+  magics/                 Jupyter %%module magic
+docs/examples/            Example notebooks
+projects/                 End-to-end project examples
+tests/                    pytest suite
+pyproject.toml            Project metadata, dependencies, tool config
+uv.lock                   Locked dependency graph (committed)
+```
+
+<h3 id="naming-conventions">🏷 Naming Conventions</h3>
+
+- ✅ **Do** follow PEP 8.
+- ✅ **Do** name classes in `CamelCase` and functions/modules in `snake_case`.
+
+<h3 id="code-quality">🔍 Code Quality</h3>
+
+- ✅ **Do** adhere to PEP 8 style guidelines.
+- ✅ **Do** use `ruff` or `black` for formatting before opening a PR.
+
+<h3 id="testing">🧪 Testing</h3>
+
+- ✅ **Do** write tests under `tests/` using `pytest`.
+- ✅ **Do** ensure all tests pass before submitting a Pull Request (`uv run pytest`).
+
+## 5. Pull Requests
+
+- ✅ **Do** ensure your branch is up to date with `main`.
+- ✅ **Do** ensure there are no merge conflicts.
+- ✅ **Do** make sure all tests pass.
+- ✅ **Do** provide a clear description of the changes and their purpose.
+
+> **TIP:** Review the existing codebase and follow the conventions used throughout the project.
+
+---
+
+Thank you for contributing! We appreciate your efforts to improve the project.