djangorestframework-mcp-server 0.1.0__tar.gz

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

@@ -0,0 +1,110 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+# Each job runs only after the previous one succeeds, so a failed test or a
+# rejected PyPI upload aborts the rest of the chain (no half-released versions).
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: build wheel + sdist
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install
+        run: uv sync --all-groups
+
+      - name: Tag version matches package version
+        # Compare the git tag (vX.Y.Z) against rest_framework_mcp.__version__.
+        # Any mismatch is a sign someone tagged without bumping version.py.
+        run: |
+          tag="${GITHUB_REF#refs/tags/}"
+          pkg_version="$(uv run python -c 'from rest_framework_mcp.version import __version__; print(__version__)')"
+          if [[ "$tag" != "v$pkg_version" ]]; then
+            echo "Tag $tag does not match package version v$pkg_version"
+            exit 1
+          fi
+
+      - name: Final test gate
+        run: uv run pytest
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    name: publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/djangorestframework-mcp-server
+    permissions:
+      # Required for OIDC trusted publishing — no API token in repo secrets.
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-docs:
+    name: publish docs to GitHub Pages
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    # Docs deployment is best-effort: if mkdocs.yml is missing the step is
+    # skipped instead of failing the release.
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Check for mkdocs.yml
+        id: docs
+        run: |
+          if [[ -f mkdocs.yml ]]; then
+            echo "present=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "present=false" >> "$GITHUB_OUTPUT"
+            echo "mkdocs.yml not found — skipping docs deploy."
+          fi
+      - name: Install with docs group
+        if: steps.docs.outputs.present == 'true'
+        run: uv sync --all-groups
+      - name: Configure git for gh-deploy
+        if: steps.docs.outputs.present == 'true'
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+      - name: Deploy to gh-pages
+        if: steps.docs.outputs.present == 'true'
+        run: |
+          DJANGO_SETTINGS_MODULE=tests.conftest_settings \
+            uv run mkdocs gh-deploy --force --clean --config-file mkdocs.yml

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

@@ -0,0 +1,169 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        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 rest_framework_mcp
+
+  docs:
+    name: docs build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install with docs group
+        run: uv sync --all-groups
+      - name: mkdocs build --strict
+        # mkdocstrings imports the package, which transitively imports DRF;
+        # DRF reads ``settings.REST_FRAMEWORK`` at import time, so we point at
+        # the test settings module to keep the build hermetic.
+        run: DJANGO_SETTINGS_MODULE=tests.conftest_settings uv run mkdocs build --strict
+
+  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"]
+        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"
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        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
+
+  smoke-no-extras:
+    name: smoke (no optional extras)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Install base only (no [toon], no [oauth], no dev group)
+        run: |
+          uv venv --python 3.13 .venv-smoke
+          .venv-smoke/bin/python -m pip install --upgrade pip
+          .venv-smoke/bin/pip install -e .
+      - name: Confirm import + server build + TOON fallback
+        run: |
+          .venv-smoke/bin/python - <<'PY'
+          import warnings
+
+          import django
+          from django.conf import settings
+
+          settings.configure(
+              SECRET_KEY="x",
+              INSTALLED_APPS=[
+                  "django.contrib.contenttypes",
+                  "django.contrib.auth",
+                  "rest_framework",
+              ],
+              DATABASES={"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}},
+              REST_FRAMEWORK_MCP={
+                  "AUTH_BACKEND": "rest_framework_mcp.auth.backends.allow_any_backend.AllowAnyBackend",
+                  "SESSION_STORE": "rest_framework_mcp.transport.in_memory_session_store.InMemorySessionStore",
+                  "ALLOWED_ORIGINS": ["*"],
+                  "SERVER_INFO": {},
+              },
+          )
+          django.setup()
+
+          from rest_framework_mcp import MCPServer
+          from rest_framework_mcp.output.encode_toon import encode_toon
+          from rest_framework_services.types.service_spec import ServiceSpec
+
+          server = MCPServer(name="smoke")
+          server.register_tool(name="noop", spec=ServiceSpec(service=lambda: None))
+          assert server.tools.get("noop") is not None
+
+          with warnings.catch_warnings(record=True) as caught:
+              warnings.simplefilter("always")
+              encode_toon({"a": 1})
+              assert any("python-toon" in str(item.message) for item in caught), (
+                  "Expected TOON fallback warning when extra is missing"
+              )
+
+          # The OAuth backend module imports fine without oauth2_provider — the
+          # ImportError only fires if a request actually hits authenticate().
+          from rest_framework_mcp.auth.backends.django_oauth_toolkit_backend import (
+              DjangoOAuthToolkitBackend,
+          )
+          backend = DjangoOAuthToolkitBackend()
+          try:
+              import oauth2_provider  # noqa: F401
+              raise SystemExit("smoke environment unexpectedly has oauth2_provider installed")
+          except ImportError:
+              pass
+
+          # The Redis SSE broker module imports fine without ``redis`` — the
+          # ImportError only fires inside ``RedisSSEBroker.__init__``.
+          from rest_framework_mcp.transport.redis_sse_broker import RedisSSEBroker
+          try:
+              RedisSSEBroker(client=object())
+              raise SystemExit("RedisSSEBroker construction should fail without redis")
+          except ImportError:
+              pass
+
+          # The OTel tracing helper falls back to a no-op span when the API
+          # isn't installed — handlers stay branch-free.
+          from rest_framework_mcp._compat.tracing import span
+          with span("mcp.smoke") as s:
+              s.set_attribute("k", "v")
+
+          print("SMOKE OK")
+          PY