model-dispatcher 0.3.0__tar.gz

model_dispatcher-0.3.0/.dockerignore

@@ -0,0 +1,13 @@
+.git
+.venv
+**/__pycache__
+**/*.pyc
+.mypy_cache
+.ruff_cache
+.pytest_cache
+demo/frontend/node_modules
+demo/frontend/dist
+demo/backend/static
+tests
+*.md
+!README.md

model_dispatcher-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,275 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  python:
+    name: Lint, type-check & test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with dev extras
+        run: pip install -e ".[dev]"
+
+      - name: Ruff lint
+        run: ruff check src tests examples
+
+      - name: Ruff format check
+        run: ruff format --check src tests examples
+
+      - name: mypy (strict)
+        run: mypy --strict src examples
+
+      - name: pytest
+        run: pytest
+
+      - name: Run the basic_agent example (smoke test)
+        run: python examples/basic_agent.py
+
+  frontend:
+    name: Build React SPA
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: demo/frontend/package-lock.json
+
+      - name: Install dependencies
+        working-directory: demo/frontend
+        run: npm ci
+
+      - name: Build
+        working-directory: demo/frontend
+        run: npm run build
+
+  ts_client:
+    name: TS client — type-check, test & build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: clients/typescript/package-lock.json
+
+      - name: Install dependencies
+        working-directory: clients/typescript
+        run: npm ci
+
+      - name: Type-check
+        working-directory: clients/typescript
+        run: npm run typecheck
+
+      - name: Test
+        working-directory: clients/typescript
+        run: npm test
+
+      - name: Build
+        working-directory: clients/typescript
+        run: npm run build
+
+  browser_agent:
+    name: Browser agent — type-check, test & build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: clients/browser-agent/package-lock.json
+
+      - name: Install dependencies
+        working-directory: clients/browser-agent
+        run: npm ci
+
+      - name: Type-check
+        working-directory: clients/browser-agent
+        run: npm run typecheck
+
+      - name: Test
+        working-directory: clients/browser-agent
+        run: npm test
+
+      - name: Build
+        working-directory: clients/browser-agent
+        run: npm run build
+
+  vercel_template_frontend:
+    name: Vercel template — build Next.js frontend
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: clients/typescript/package-lock.json
+
+      - name: Build the TS client
+        working-directory: clients/typescript
+        run: |
+          npm ci
+          npm run build
+
+      - name: Point the template at the workspace TS client
+        # @joka-7/modeldispatcher-client is only published on a tagged release
+        # (see release.yml) and may not exist yet or may lag this commit.
+        # Building against the workspace copy means this check is self-contained
+        # and always exercises the client code actually changed in this PR —
+        # not a possibly-stale published version.
+        working-directory: templates/vercel-app
+        run: |
+          node -e "
+            const fs = require('fs');
+            const p = JSON.parse(fs.readFileSync('package.json', 'utf8'));
+            p.dependencies['@joka-7/modeldispatcher-client'] = 'file:../../clients/typescript';
+            fs.writeFileSync('package.json', JSON.stringify(p, null, 2) + '\n');
+          "
+
+      - name: Install template dependencies
+        # npm install, not ci: the file: dependency swap above intentionally
+        # diverges from package-lock.json.
+        working-directory: templates/vercel-app
+        run: npm install
+
+      - name: Type-check
+        working-directory: templates/vercel-app
+        run: npm run typecheck
+
+      - name: Build (next build)
+        # A real build with zero Firebase env vars set — this is what catches
+        # both a missing/broken app/lib/gateway.ts and any Firebase call that
+        # isn't properly deferred to runtime (see that file's module doc).
+        working-directory: templates/vercel-app
+        run: npm run build
+        env:
+          NEXT_TELEMETRY_DISABLED: "1"
+
+  vercel_template:
+    name: Vercel template — lint & test wrapper (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install gateway (dev extras) + wrapper dependencies
+        run: |
+          pip install -e ".[dev]"
+          pip install firebase-admin
+
+      - name: Ruff lint
+        run: ruff check templates
+
+      - name: Ruff format check
+        run: ruff format --check templates
+
+      - name: mypy (lenient — firebase-admin ships no type stubs)
+        env:
+          MYPYPATH: templates/vercel-app/api
+        run: >
+          mypy --config-file= --ignore-missing-imports
+          templates/vercel-app/api/gateway.py
+          templates/vercel-app/api/_lib
+
+      - name: pytest (dispatch pipeline)
+        run: pytest templates/vercel-app/api/tests
+
+  docker:
+    name: Build & publish demo image
+    runs-on: ubuntu-latest
+    needs: [python, frontend]
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GHCR
+        # Publish only from the default branch; feature branches and PRs build
+        # the image (validating the Dockerfile) without pushing.
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Image metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=branch
+            type=sha
+            type=raw,value=latest,enable={{is_default_branch}}
+
+      - name: Build (and push from the default branch)
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+  # ----------------------------------------------------------------------- #
+  # Deploy the published image to a hosting target. This is intentionally a
+  # manual, gated stub: wire it to your platform (Fly.io / Render / Cloud Run /
+  # a k8s cluster) by adding the deploy step and the platform token as a repo
+  # secret. It runs only on the default branch so feature branches don't deploy.
+  # ----------------------------------------------------------------------- #
+  deploy:
+    name: Deploy demo (configure target)
+    runs-on: ubuntu-latest
+    needs: docker
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    environment: demo
+    steps:
+      - name: Pending deploy target
+        run: |
+          echo "Image published to ghcr.io/${{ github.repository }}:latest"
+          echo "Add your host's deploy step here (e.g. flyctl deploy / render deploy"
+          echo "/ gcloud run deploy) plus its token as a repository secret."

model_dispatcher-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,221 @@
+name: Release
+
+# Triggered by pushing a version tag (e.g. `v0.2.0`). This publishes
+# model-dispatcher to PyPI and the matching @joka-7/modeldispatcher-client
+# build to GitHub Packages, and is what makes the git-pinned installs in
+# templates/vercel-app/api/requirements.txt (and the README's
+# `git+...@v0.2.0` examples) resolve to a real, published point in history.
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  verify:
+    name: Re-verify the tagged commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install package with dev extras
+        run: |
+          pip install -e ".[dev]"
+          pip install firebase-admin
+
+      - name: Ruff lint
+        run: ruff check src tests templates
+
+      - name: Ruff format check
+        run: ruff format --check src tests templates
+
+      - name: mypy (strict, core library)
+        run: mypy --strict src
+
+      - name: pytest (core library + Vercel template)
+        run: pytest tests templates/vercel-app/api/tests
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: clients/typescript/package-lock.json
+
+      - name: Install TS client dependencies
+        working-directory: clients/typescript
+        run: npm ci
+
+      - name: TS type-check
+        working-directory: clients/typescript
+        run: npm run typecheck
+
+      - name: TS test
+        working-directory: clients/typescript
+        run: npm test
+
+      - name: Set up Node (browser agent)
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: clients/browser-agent/package-lock.json
+
+      - name: Install browser-agent dependencies
+        working-directory: clients/browser-agent
+        run: npm ci
+
+      - name: Browser agent type-check
+        working-directory: clients/browser-agent
+        run: npm run typecheck
+
+      - name: Browser agent test
+        working-directory: clients/browser-agent
+        run: npm test
+
+  publish_pypi:
+    name: Publish model-dispatcher to PyPI
+    runs-on: ubuntu-latest
+    needs: verify
+    environment: pypi
+    permissions:
+      # Required for PyPI Trusted Publishing (OIDC) — no API token/secret needed.
+      # A "pending publisher" must be registered on PyPI first: Account Settings
+      # → Publishing, with owner=joka-7, repo=ModelDispatcher, workflow=release.yml.
+      # If that publisher was registered *without* an environment name, delete the
+      # `environment: pypi` line above to match.
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: pip install build
+
+      - name: Verify pyproject.toml version matches the pushed tag
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          pkg_version="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          if [ "$tag_version" != "$pkg_version" ]; then
+            echo "::error::tag v$tag_version does not match pyproject.toml version $pkg_version"
+            exit 1
+          fi
+
+      - name: Build sdist + wheel
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish_ts_client:
+    name: Publish @joka-7/modeldispatcher-client
+    runs-on: ubuntu-latest
+    needs: verify
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          registry-url: "https://npm.pkg.github.com"
+          scope: "@joka-7"
+          cache: npm
+          cache-dependency-path: clients/typescript/package-lock.json
+
+      - name: Install dependencies
+        working-directory: clients/typescript
+        run: npm ci
+
+      - name: Build
+        working-directory: clients/typescript
+        run: npm run build
+
+      - name: Verify package.json version matches the pushed tag
+        working-directory: clients/typescript
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          pkg_version="$(node -p "require('./package.json').version")"
+          if [ "$tag_version" != "$pkg_version" ]; then
+            echo "::error::tag v$tag_version does not match package.json version $pkg_version"
+            exit 1
+          fi
+
+      - name: Publish to GitHub Packages
+        working-directory: clients/typescript
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish_browser_agent:
+    name: Publish @joka-7/modeldispatcher-browser-agent
+    runs-on: ubuntu-latest
+    needs: verify
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          registry-url: "https://npm.pkg.github.com"
+          scope: "@joka-7"
+          cache: npm
+          cache-dependency-path: clients/browser-agent/package-lock.json
+
+      - name: Install dependencies
+        working-directory: clients/browser-agent
+        run: npm ci
+
+      - name: Build
+        working-directory: clients/browser-agent
+        run: npm run build
+
+      - name: Verify package.json version matches the pushed tag
+        working-directory: clients/browser-agent
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          pkg_version="$(node -p "require('./package.json').version")"
+          if [ "$tag_version" != "$pkg_version" ]; then
+            echo "::error::tag v$tag_version does not match package.json version $pkg_version"
+            exit 1
+          fi
+
+      - name: Publish to GitHub Packages
+        working-directory: clients/browser-agent
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  create_release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: [publish_pypi, publish_ts_client, publish_browser_agent]
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create release with auto-generated notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release create "${{ github.ref_name }}" --generate-notes