drf-query-method 0.1.0__tar.gz

drf_query_method-0.1.0/.editorconfig

@@ -0,0 +1,37 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{html,css,js,json,sh,yml,yaml}]
+indent_size = 2
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[justfile]
+indent_style = space
+indent_size = 4
+
+# Ignore binary or generated files
+[*.{png,jpg,gif,ico,woff,woff2,ttf,eot,svg,pdf}]
+charset = unset
+end_of_line = unset
+indent_style = unset
+indent_size = unset
+trim_trailing_whitespace = unset
+insert_final_newline = unset
+max_line_length = unset
+
+[*.{diff,patch}]
+trim_trailing_whitespace = false

drf_query_method-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: Bug Report
+description: Something isn't working as expected.
+title: "BUG: "
+labels: [bug]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: What happened? What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Minimal steps to trigger the bug.
+      placeholder: |
+        1. Install with `uv pip install drf-query-method`
+        2. Run `...`
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: "drf-query-method version"
+      placeholder: "0.1.0"
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      placeholder: "3.13"
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      options:
+        - macOS
+        - Linux
+        - Windows
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Logs, tracebacks, screenshots, or anything else that helps.
+    validations:
+      required: false

drf_query_method-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

drf_query_method-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,30 @@
+name: Feature Request
+description: Suggest something new.
+title: "FEAT: "
+labels: [enhancement]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: What problem does this solve? What's the use case?
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+    validations:
+      required: false

drf_query_method-0.1.0/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+    open-pull-requests-limit: 5

drf_query_method-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## What
+
+<!-- 1-3 sentences. Link the issue if there is one. -->
+
+## AI Provenance
+
+<!-- Remove this section for human-authored PRs. -->
+
+- **Tool:** <!-- Claude Code, Cursor, Copilot, Codex, etc. -->
+- **Model:** <!-- Claude Opus 4.6, GPT-4o, etc. -->
+- **Prompt/thread:** <!-- Paste your prompt or a link to the thread. -->
+
+## Checklist
+
+- [ ] Addresses exactly one issue or feature
+- [ ] New or changed behavior has test coverage
+- [ ] Diff contains only changes for this task

drf_query_method-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,149 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+  type-check:
+    name: Type check
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+      - name: Type check with ty
+        run: uv run ty check .
+
+  test:
+    name: Test (Python ${{ matrix.python }}, Django ${{ matrix.django }}, DRF ${{ matrix.drf }})
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    continue-on-error: ${{ matrix.experimental || false }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { python: "3.10", django: "4.2", drf: "3.16" }
+          - { python: "3.11", django: "5.0", drf: "3.16" }
+          - { python: "3.12", django: "5.1", drf: "3.16" }
+          - { python: "3.12", django: "4.2", drf: "3.17" }
+          - { python: "3.13", django: "5.2", drf: "3.17" }
+          - { python: "3.13", django: "6.0", drf: "3.17" }
+          - { python: "3.12", django: "5.2", drf: "3.18" }
+          - { python: "3.14", django: "6.0", drf: "3.18" }
+          - { python: "3.14", django: "6.1", drf: "3.18" }
+          - { python: "3.14", django: "main", drf: "main", experimental: true }
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+      - name: Install Django ${{ matrix.django }} and DRF ${{ matrix.drf }}
+        env:
+          PYTHON: ${{ matrix.python }}
+          DJANGO: ${{ matrix.django }}
+          DRF: ${{ matrix.drf }}
+        run: |
+          if [ "$DJANGO" = "main" ]; then
+            django_req="django @ https://github.com/django/django/archive/main.tar.gz"
+          else
+            django_req="django~=$DJANGO.0"
+          fi
+          if [ "$DRF" = "main" ]; then
+            drf_req="djangorestframework @ https://github.com/encode/django-rest-framework/archive/main.tar.gz"
+          else
+            drf_req="djangorestframework~=$DRF.0"
+          fi
+          uv venv --python "$PYTHON"
+          uv pip install -e . "$django_req" "$drf_req" django-filter coverage pytest pytest-django
+
+      - name: Run tests with coverage
+        run: .venv/bin/coverage run -m pytest
+
+      - name: Upload coverage data
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: coverage-${{ matrix.python }}-${{ matrix.django }}-${{ matrix.drf }}
+          path: .coverage.*
+          include-hidden-files: true
+
+  coverage:
+    name: Coverage
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+      - name: Download coverage data
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          pattern: coverage-*
+          merge-multiple: true
+
+      - name: Combine coverage
+        run: uv run coverage combine
+
+      - name: Coverage report
+        run: |
+          echo '## Coverage Report' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          uv run coverage report | tee -a $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+
+  all-checks-pass:
+    name: All checks pass
+    if: always()
+    needs: [lint, type-check, test, coverage]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check job results
+        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
+        with:
+          jobs: ${{ toJSON(needs) }}

drf_query_method-0.1.0/.github/workflows/codeql.yml

@@ -0,0 +1,35 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: '0 6 * * 1'
+
+permissions: {}
+
+jobs:
+  analyze:
+    name: Analyze
+    if: ${{ github.event.repository.private == false || vars.CODE_SECURITY_ENABLED == 'true' }}
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4.37.3
+        with:
+          languages: python  # Add c-cpp, go, java-kotlin, or swift if needed
+          build-mode: none   # Switch to autobuild for compiled languages
+          queries: security-extended
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4.37.3

drf_query_method-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions: {}
+
+concurrency:
+  group: docs-deploy
+  # Let in-flight deployments finish to avoid a half-deployed site.
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build
+    if: ${{ vars.DOCS_DEPLOYMENT_ENABLED == 'true' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+      - name: Build docs
+        run: uv run --group docs zensical build --clean
+
+      - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
+
+      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: site
+
+  deploy:
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
+        id: deployment

drf_query_method-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,64 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions: {}
+
+concurrency:
+  group: publish
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      # Cache disabled to prevent cache-poisoning attacks on release artifacts.
+      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: false
+
+      - name: Build
+        run: uv build
+
+      - name: Upload distribution
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      attestations: write
+    # Requires environment protection rules in GitHub Settings:
+    # Settings > Environments > pypi > Add required reviewers
+    # and restrict deployment to v* tags.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/drf-query-method
+    steps:
+      - name: Download distribution
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+
+      - name: Attest build provenance
+        uses: actions/attest-build-provenance@0f67c3f4856b2e3261c31976d6725780e5e4c373 # v4.1.1
+        with:
+          subject-path: "dist/*"
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

drf_query_method-0.1.0/.github/workflows/zizmor.yml

@@ -0,0 +1,37 @@
+name: Workflow security analysis
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/**"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+    paths:
+      - ".github/workflows/**"
+
+permissions: {}
+
+jobs:
+  zizmor:
+    name: Run zizmor
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Run zizmor
+        uses: zizmorcore/zizmor-action@6fc4b006235f201fdab3722e17240ab420d580e5 # v0.6.1
+        with:
+          advanced-security: ${{ github.event.repository.private == false || vars.CODE_SECURITY_ENABLED == 'true' }}
+          inputs: ./.github/

drf_query_method-0.1.0/.gitignore

@@ -0,0 +1,54 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+build/
+dist/
+eggs/
+.eggs/
+*.egg-info/
+*.egg
+MANIFEST
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+coverage.xml
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.envrc
+.venv
+
+# uv
+#   Generally recommended to include uv.lock in version control for
+#   reproducibility. Uncomment for libraries where you want consumers
+#   to resolve their own dependencies.
+# uv.lock
+
+# Ruff
+.ruff_cache/
+
+# Type checkers
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+
+# Documentation build output
+site/
+
+# IDE files
+# .idea/
+# .vscode/

drf_query_method-0.1.0/CHANGELOG/0.1.0.md

@@ -0,0 +1,28 @@
+# drf-query-method 0.1.0
+
+These are the changes that will go out in the next release.
+
+## Added
+
+- `patch()`, which adds `QUERY` support to DRF in place, and to django-filter's `DjangoFilterBackend` when installed.
+- Opt-in routers, viewsets, filters, permissions, test clients and a django-filter backend, named after DRF's.
+- `filter_params()`, the URL query parameters with a `QUERY` request's body merged over them.
+- `add_query_method()`, which lets Django versions before 6.2 dispatch `QUERY`.
+- Documentation for both approaches, and for sending `QUERY` requests from clients.
+
+drf-query-method started out as a project generated from [Cookiecutter PyPackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) containing:
+
+- Initial scaffold for drf-query-method.
+- `src/drf_query_method/` package with a py.typed marker
+- Tests with pytest and pytest-django
+- CI via GitHub Actions: lint (Ruff), type check (ty), a Python/Django/DRF test matrix, coverage reporting
+- Security scanning: CodeQL analysis for public repositories, Dependabot, and a Zizmor workflow audit
+- Docs site with Zensical + mkdocstrings and a GitHub Pages deployment workflow
+- Trusted publishing to PyPI with OIDC and build provenance attestation
+- `justfile` with dev commands: qa, test, type-check, docs-serve, release
+- Issue templates, PR template, contributing guide, code of conduct, security policy
+- BSD 3-Clause license, .editorconfig, .gitignore
+
+### Contributors
+
+[@BenA-SA](https://github.com/BenA-SA) (Ben Atkinson) created drf-query-method.

drf_query_method-0.1.0/CHANGELOG/unreleased.md

@@ -0,0 +1,3 @@
+# Unreleased
+
+Record user-visible changes here before the next release.