django-spec-agents 0.1.0__tar.gz

django_spec_agents-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @Artui

django_spec_agents-0.1.0/.github/SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report security issues **privately** via GitHub's
+[Report a vulnerability](../../security/advisories/new) button rather than opening a public issue.
+I aim to acknowledge reports within 72 hours.
+
+Supported: the latest released version on the default branch.

django_spec_agents-0.1.0/.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    # Dependabot already holds a new version for 3 days before proposing it; a
+    # week is the more useful threshold. A compromised release is typically
+    # yanked within days, so the gap between "published" and "found" is exactly
+    # the window an automatic upgrade walks into. This costs nothing in
+    # responsiveness that matters: cooldown covers version updates only, and
+    # security advisories are proposed immediately regardless.
+    cooldown:
+      default-days: 7
+    groups:
+      actions:
+        patterns: ["*"]
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    groups:
+      python:
+        patterns: ["*"]

django_spec_agents-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,97 @@
+name: release
+
+# Main-triggered: every merge to `main` runs `release-publish-prepare`, which
+# short-circuits to a no-op unless the version in source has been bumped past
+# the most recent `vX.Y.Z` tag.
+on:
+  push:
+    branches: [main]
+
+concurrency:
+  group: release-main
+  cancel-in-progress: false
+
+# Actions are pinned to a commit SHA rather than a tag: a tag is mutable, and an
+# action owner (or anyone who takes over the account) can silently repoint one at
+# new code that then runs with this workflow's token. The trailing version comment
+# is not decoration -- Dependabot reads it to know which release the SHA is, and
+# rewrites both together when a newer one ships.
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/django-spec-agents
+    permissions:
+      id-token: write   # PyPI OIDC trusted publishing
+      contents: write   # tag push + gh release create
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - name: Install
+        run: uv sync --all-groups
+
+      - name: Prepare release (version check, test, build dist)
+        id: prepare
+        run: make release-publish-prepare
+
+      - name: Publish to PyPI
+        if: steps.prepare.outputs.released == 'true'
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          # Idempotent on purpose. What gates a release is the git tag, not the
+          # index (see `prepare`), so re-running this job after a failure in a
+          # later step arrives here having already uploaded these files. Without
+          # this the upload is the step that makes that re-run impossible, and
+          # every recovery becomes manual — which is how one release lost its tag,
+          # its GitHub Release and its docs deploy to a single transient push
+          # failure, with the package already published.
+          # PyPI never lets a file be replaced, so skipping one cannot overwrite
+          # a published artefact.
+          skip-existing: true
+
+      - name: Tag + GitHub Release
+        if: steps.prepare.outputs.released == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: make release-publish-finalize
+
+      # Embed a coverage-badge JSON into the docs build so `mkdocs gh-deploy`
+      # carries it to the gh-pages root, where the README's shields.io endpoint
+      # badge reads it. `release-publish-prepare`'s pytest run wrote .coverage
+      # to the workspace root.
+      - name: Render coverage badge for the docs site
+        if: steps.prepare.outputs.released == 'true' && hashFiles('mkdocs.yml') != ''
+        run: |
+          set -euo pipefail
+          uv run coverage xml -o coverage.xml
+          python - <<'PY'
+          import json
+          import xml.etree.ElementTree as ET
+
+          pct = round(float(ET.parse("coverage.xml").getroot().attrib["line-rate"]) * 100, 1)
+          color = (
+              "brightgreen" if pct >= 95
+              else "green" if pct >= 85
+              else "yellow" if pct >= 70
+              else "red"
+          )
+          payload = {"schemaVersion": 1, "label": "coverage", "message": f"{pct}%", "color": color}
+          with open("docs/coverage.json", "w") as fh:
+              json.dump(payload, fh)
+              fh.write("\n")
+          print(json.dumps(payload))
+          PY
+
+      - name: Deploy docs + coverage badge to gh-pages
+        if: steps.prepare.outputs.released == 'true' && hashFiles('mkdocs.yml') != ''
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          DJANGO_SETTINGS_MODULE=tests.conftest_settings \
+            uv run mkdocs gh-deploy --force --clean --config-file mkdocs.yml

django_spec_agents-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,440 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+# Actions are pinned to a commit SHA rather than a tag: a tag is mutable, and an
+# action owner (or anyone who takes over the account) can silently repoint one at
+# new code that then runs with this workflow's token. The trailing version comment
+# is not decoration -- Dependabot reads it to know which release the SHA is, and
+# rewrites both together when a newer one ships.
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - name: Install
+        run: uv sync --all-groups
+      - name: ruff check
+        run: uv run ruff check .
+      - name: ruff format check
+        run: uv run ruff format --check --diff .
+      - name: ty
+        run: uv run ty check django_spec_agents
+
+  docs:
+    name: docs build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - name: Install with docs group
+        run: uv sync --all-groups
+      - name: mkdocs build --strict
+        run: DJANGO_SETTINGS_MODULE=tests.conftest_settings uv run mkdocs build --strict
+
+  floor:
+    name: lowest declared versions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      # A floor is a claim about the *oldest* version that works, and a lockfile
+      # can only ever check the newest. Development and CI both resolve the
+      # newest in-range dependency, so every gate passes while a consumer whose
+      # own constraints pull an older one gets a package that does not import.
+      #
+      # That has already happened in this ecosystem: a sibling declared
+      # pydantic-ai >=2 while importing a symbol that first exists in 2.16, and
+      # the only thing that found it was a downstream consumer resolving from
+      # scratch.
+      #
+      # `lowest-direct` pins every *declared* dependency to the bottom of its
+      # window while letting transitives resolve normally, so this asserts the
+      # floors mean what they say. A per-PR gate rather than a scheduled job,
+      # because a floor stops being true the moment someone imports a newer
+      # upstream symbol -- a code change, not the passage of time.
+      # Also the oldest supported interpreter: a floor claim covers Python
+      # too, and a dependency old enough to sit at its floor is the one most
+      # likely to use something a newer Python removed.
+      - name: Use the floor Python
+        run: uv python install 3.10
+      # `--refresh` on both resolutions below. This job's whole claim is "what a
+      # consumer resolving from scratch would get", and the runner's uv cache is
+      # shared across runs: without it the answer comes from whatever package
+      # list that cache happens to hold, which can be hours behind the index.
+      # Not hypothetical -- a sibling's gate failed a floor raise as
+      # unsatisfiable while the index had been serving the release for some
+      # time, two re-runs reused the same cache and failed identically, and a
+      # cacheless resolve of the same requirement succeeded at once. A stale
+      # listing makes this gate report the past, in whichever direction happens
+      # to be wrong: inventing a broken floor, or hiding a real one.
+      - name: Resolve every declared dependency at its floor
+        run: uv lock --resolution lowest-direct --python 3.10 --refresh
+      # --frozen and --no-sync are load-bearing, not tidiness. uv records the
+      # resolution mode in the lockfile and silently discards a lock resolved
+      # in a different one -- a plain `uv sync` here prints "Ignoring existing
+      # lockfile due to change in resolution mode: lowest-direct vs. highest"
+      # and re-resolves at the newest versions, so the job reports the oldest
+      # end while testing the newest. It did exactly that when first written.
+      - name: Install exactly what was locked
+        run: uv sync --frozen --all-groups --all-extras --python 3.10
+      - name: Name the versions that produced
+        run: uv pip list
+      - name: Test
+        run: uv run --no-sync pytest
+
+      # The step above installs every extra, and an extra can hold a shared
+      # dependency *above* the floor being claimed -- masking the lie rather
+      # than exposing it. That is not hypothetical: reverting a sibling's
+      # pydantic-ai floor to its old value and resolving with all extras kept
+      # that dependency at 2.18 because another extra required it, and the
+      # suite passed. The same revert on a plain base install resolved 2.0 and
+      # failed at import, which is exactly how the original defect reached a
+      # consumer.
+      #
+      # So the floor claim has to be checked on the install shape that has the
+      # fewest constraints: the package alone, no extras, no dev group.
+      - name: Import the package installed alone, at its floors
+        run: |
+          uv venv --python 3.10 .venv-floor
+          uv pip install --python .venv-floor/bin/python --resolution lowest-direct --refresh -e .
+          uv pip list --python .venv-floor/bin/python
+          .venv-floor/bin/python - <<'PY'
+          import django
+          from django.conf import settings
+
+          # The package reaches for Django at import time (models, requests,
+          # storage), so a bare import cannot run unconfigured.
+          settings.configure(
+              SECRET_KEY="x",
+              INSTALLED_APPS=[
+                  "django.contrib.contenttypes",
+                  "django.contrib.auth",
+              ],
+              DATABASES={"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}},
+          )
+          django.setup()
+
+          import django_spec_agents
+          from django_spec_agents import AgentConfig, ToolRegistry, build_agent, tool
+
+          # Touch the public surface rather than only the package root: an
+          # upstream symbol that moved would be imported by a leaf module, and
+          # importing the root alone can miss it.
+          assert callable(build_agent)
+          assert callable(tool)
+          assert AgentConfig is not None and ToolRegistry is not None
+          print("BASE IMPORT OK", django.get_version(), django_spec_agents.__version__)
+          PY
+
+  # The package with no extra is what django-admin-agent ships, and the boundary
+  # tests are what keep it importable that way: the root loads nothing of
+  # ``spec_tools`` or the ``[specs]`` extra. Every other job installs every extra,
+  # where a root import of ``spec_tools`` would still import, so this one installs
+  # none and runs those tests alone. The floor job's base import proves the root
+  # imports at its floors; this proves what it leaves unloaded, under the settings
+  # of a project serving no specs. No coverage gate: these tests alone cover
+  # little of the package, and the suite that covers it needs the extras.
+  host-only:
+    name: host-only install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - name: Boundary tests on an install with no extra
+        run: make test-host-only
+
+  # The store's upgrade renames PostgreSQL's ``_like`` index, which Django drops by
+  # a name it computes from the table rather than by looking it up, so a missed
+  # rename leaves a duplicate index behind the next type change. SQLite makes no
+  # such index, so only a real server can show the rename happened.
+  store-upgrade-postgresql:
+    name: store upgrade on PostgreSQL
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_DB: store_upgrade
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - name: Sync dev deps
+        run: uv sync --all-groups
+      - name: Install the PostgreSQL driver
+        run: uv pip install "psycopg[binary]"
+      - name: pytest
+        env:
+          STORE_UPGRADE_ENGINE: django.db.backends.postgresql
+          STORE_UPGRADE_DATABASE: store_upgrade
+          STORE_UPGRADE_HOST: localhost
+          STORE_UPGRADE_USER: postgres
+        run: |
+          uv run --no-sync pytest -q --no-cov \
+            tests/contrib/store/test_upgrade_from_django_pydantic_agent.py
+
+  test:
+    name: ${{ matrix.python-version }} / Django ${{ matrix.django-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        django-version: ["4.2", "5.0", "5.1", "5.2", "6.0", "6.1"]
+        exclude:
+          # Django 4.2 supports Python 3.8–3.12
+          - python-version: "3.13"
+            django-version: "4.2"
+          - python-version: "3.14"
+            django-version: "4.2"
+          # Django 5.0 supports Python 3.10–3.12
+          - python-version: "3.13"
+            django-version: "5.0"
+          - python-version: "3.14"
+            django-version: "5.0"
+          # Django 5.1 supports Python 3.10–3.13
+          - python-version: "3.14"
+            django-version: "5.1"
+          # Django 6.0 requires Python 3.12+
+          - python-version: "3.10"
+            django-version: "6.0"
+          - python-version: "3.11"
+            django-version: "6.0"
+          # Django 6.1 requires Python 3.12+
+          - python-version: "3.10"
+            django-version: "6.1"
+          - python-version: "3.11"
+            django-version: "6.1"
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: true
+      - name: Install Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Sync dev deps
+        run: uv sync --all-groups --python ${{ matrix.python-version }}
+      - name: Pin Django ${{ matrix.django-version }}
+        run: uv pip install --reinstall-package django "django~=${{ matrix.django-version }}.0"
+      - name: pytest
+        run: |
+          uv run --no-sync pytest \
+            --cov-report=xml:coverage.xml \
+            --cov-report=html:htmlcov
+      - name: Upload coverage artifact
+        if: always()
+        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: coverage-py${{ matrix.python-version }}-django${{ matrix.django-version }}
+          path: |
+            coverage.xml
+            htmlcov/
+          if-no-files-found: ignore
+
+  coverage-badge:
+    # Publishes a shields.io-compatible coverage.json to gh-pages so the README
+    # badge reflects reality. Runs only on push to main, after the matrix has
+    # produced an artifact we can read from.
+    name: coverage badge
+    needs: test
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          # Need the parent commit so the gate step below can diff
+          # version.py against ${{ github.event.before }}. The default
+          # shallow checkout (depth 1) would make `git show "$before:…"`
+          # fail with exit 128 and turn the whole job red.
+          fetch-depth: 2
+      # release.yml runs in parallel on the same push and owns gh-pages
+      # publishing on release commits (it bundles coverage.json into the
+      # mkdocs gh-deploy). If we also push here we get a second built-in
+      # "pages build and deployment" run that the first one cancels. The
+      # version-diff against ${{ github.event.before }} is the reliable
+      # signal — release.yml's tag isn't pushed until after PyPI publish,
+      # so a tag-existence check would race.
+      - name: Skip when release.yml owns this push
+        id: gate
+        run: |
+          set -euo pipefail
+          before="${{ github.event.before }}"
+          if [[ -z "$before" || "$before" =~ ^0+$ ]]; then
+              # First push to main on a brand-new repo — no prior state to diff.
+              echo "skip=false" >> "$GITHUB_OUTPUT"
+              exit 0
+          fi
+          # `before` may not be in the local object DB if the push
+          # contained more than one commit (fetch-depth: 2 only guarantees
+          # HEAD + 1 parent). Try to fetch just that commit; if it's not
+          # reachable, fall back to "don't skip" — better to double-push
+          # to gh-pages once than to turn the pipeline red.
+          if ! git cat-file -e "$before^{commit}" 2>/dev/null; then
+              git fetch --depth=1 origin "$before" 2>/dev/null || true
+          fi
+          old=""
+          if git cat-file -e "$before:django_spec_agents/version.py" 2>/dev/null; then
+              old="$(git show "$before:django_spec_agents/version.py" \
+                     | awk -F'"' '/^__version__/ { print $2; exit }')"
+          fi
+          new="$(awk -F'"' '/^__version__/ { print $2; exit }' \
+                 django_spec_agents/version.py)"
+          if [[ -n "$old" && "$old" != "$new" ]]; then
+              echo "Version bumped $old → $new; release.yml will deploy gh-pages."
+              echo "skip=true" >> "$GITHUB_OUTPUT"
+          else
+              echo "skip=false" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Download canonical coverage artifact
+        if: steps.gate.outputs.skip != 'true'
+        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          # Pin to one cell of the matrix — coverage is the same shape across
+          # all cells and we only need one number.
+          name: coverage-py3.13-django5.2
+          path: coverage-artifact/
+      - name: Render coverage.json
+        if: steps.gate.outputs.skip != 'true'
+        run: |
+          python - <<'PY'
+          import json
+          import xml.etree.ElementTree as ET
+
+          tree = ET.parse("coverage-artifact/coverage.xml")
+          pct = round(float(tree.getroot().attrib["line-rate"]) * 100, 1)
+          if pct >= 95:
+              color = "brightgreen"
+          elif pct >= 85:
+              color = "green"
+          elif pct >= 70:
+              color = "yellow"
+          else:
+              color = "red"
+          payload = {
+              "schemaVersion": 1,
+              "label": "coverage",
+              "message": f"{pct}%",
+              "color": color,
+          }
+          with open("coverage.json", "w") as fh:
+              json.dump(payload, fh)
+              fh.write("\n")
+          print(json.dumps(payload))
+          PY
+      - name: Publish coverage.json to gh-pages
+        if: steps.gate.outputs.skip != 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+
+          tmp="$(mktemp -d)"
+          cp coverage.json "$tmp/coverage.json"
+
+          git fetch origin gh-pages --depth=1 2>/dev/null || true
+          if git rev-parse --verify origin/gh-pages >/dev/null 2>&1; then
+              git worktree add gh-pages origin/gh-pages
+              cp "$tmp/coverage.json" gh-pages/coverage.json
+              cd gh-pages
+              if [[ -n "$(git status --porcelain coverage.json)" ]]; then
+                  git add coverage.json
+                  git commit -m "coverage badge: update from ${GITHUB_SHA::7}"
+                  git push origin HEAD:gh-pages
+              else
+                  echo "coverage.json unchanged, skipping push"
+              fi
+          else
+              # First run before docs deploy. Lay down an orphan gh-pages with
+              # just the badge file; the docs deploy will overwrite the rest.
+              git worktree add --detach gh-pages
+              cd gh-pages
+              git checkout --orphan gh-pages
+              git rm -rf . >/dev/null 2>&1 || true
+              cp "$tmp/coverage.json" coverage.json
+              git add coverage.json
+              git commit -m "coverage badge: initial publish from ${GITHUB_SHA::7}"
+              git push origin gh-pages
+          fi
+
+  secrets:
+    name: secret scan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+      - name: Install gitleaks
+        run: |
+          curl -sSL https://github.com/gitleaks/gitleaks/releases/download/v8.30.1/gitleaks_8.30.1_linux_x64.tar.gz | tar -xz gitleaks
+          sudo mv gitleaks /usr/local/bin/
+      - name: Scan repo + history
+        run: gitleaks git --redact --no-banner .
+
+  tests-passed:
+    name: tests
+    # always(), never !cancelled(): a skipped job reports a skipped check, and
+    # branch protection counts a skipped required check as passing.
+    if: always()
+    needs: [lint, docs, floor, host-only, store-upgrade-postgresql, test]
+    runs-on: ubuntu-latest
+    steps:
+      # Pass on an exact `success` from every job above, rather than failing on
+      # a list of bad results: such a list passes whatever it does not name, and
+      # GitHub reports a result it does not document. A job no hosted runner
+      # ever picks up ("The job was not acquired by Runner of type hosted even
+      # after multiple attempts") shows as cancelled on its own check but
+      # reaches `needs` as `abandoned`, and a gate that failed only on `failure`
+      # and `cancelled` went green over exactly that while the jobs it guards
+      # never ran. A matrix reaches `needs` as one result, and one cell that did
+      # not succeed is enough to make it something other than `success`.
+      #
+      # None of the jobs above has an `if:`, so `skipped` can only mean one of
+      # them never ran, and it fails like any other result. A job that gains a
+      # legitimate skip gets an exception naming it, never `skipped` accepted
+      # from all of them.
+      #
+      # The results come in through `env` rather than being spliced into the
+      # script, and every one is printed, so a red gate says which job and what
+      # GitHub reported for it.
+      - name: Verify every required job succeeded
+        env:
+          NEEDS: ${{ toJSON(needs) }}
+        run: |
+          echo "$NEEDS" | jq -r 'to_entries[] | "\(.key): \(.value.result)"'
+          not_ok="$(echo "$NEEDS" | jq -r '[to_entries[] | select(.value.result != "success") | "\(.key)=\(.value.result)"] | join(" ")')"
+          if [ -n "$not_ok" ]; then
+            echo "::error::required jobs did not succeed: $not_ok"
+            exit 1
+          fi