djapi-guard 1.0.0__tar.gz

djapi_guard-1.0.0/.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: rennf93
+tidelift: pypi/djapi-guard
+custom: ['https://paypal.me/renzof93']

djapi_guard-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,78 @@
+---
+
+name: Bug report
+about: Create a report to help us improve DjangoAPI Guard
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+Bug Description
+===============
+
+A clear and concise description of what the bug is.
+
+___
+
+Steps To Reproduce
+------------------
+
+Steps to reproduce the behavior:
+
+1. Configure DjangoAPI Guard with '...'
+2. Make request to endpoint '....'
+3. See error
+
+___
+
+Expected Behavior
+-----------------
+
+A clear and concise description of what you expected to happen.
+
+___
+
+Actual Behavior
+---------------
+
+What actually happened, including error messages, stack traces, or logs.
+
+___
+
+Environment
+-----------
+
+- DjangoAPI Guard version: [e.g. 1.0.0]
+- Python version: [e.g. 3.11.10]
+- Django version: [e.g. 5.1.0]
+- OS: [e.g. Ubuntu 22.04, Windows 11, MacOS 15.4]
+- Other relevant dependencies:
+
+___
+
+Configuration
+-------------
+
+```python
+# Include your DjangoAPI Guard configuration here
+# settings.py
+MIDDLEWARE = [
+    "djangoapi_guard.middleware.DjangoAPIGuardMiddleware",
+    # ...
+]
+
+DJANGOAPI_GUARD = {
+    # Include your config here
+}
+```
+
+___
+
+Additional Context
+------------------
+
+Add any other context about the problem here. For example:
+
+- Is this happening in production or development?
+- Does it happen consistently or intermittently?
+- Have you tried any workarounds?

djapi_guard-1.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Django API Guard Documentation
+    url: https://rennf93.github.io/djapi-guard/
+    about: Check the documentation for usage information and tutorials
+  - name: Usage Questions
+    url: https://github.com/rennf93/djapi-guard/discussions
+    about: Please ask and answer questions in GitHub Discussions

djapi_guard-1.0.0/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,53 @@
+---
+
+name: Documentation
+about: Report issues with the DjangoAPI Guard documentation or suggest improvements
+title: '[DOCS] '
+labels: documentation
+assignees: ''
+---
+
+Documentation Issue
+===================
+
+Describe the issue or improvement needed for the documentation.
+
+___
+
+Current Documentation
+---------------------
+
+Link to the current documentation page or section that needs improvement:
+[Link it here](https://example.com)
+
+___
+
+Suggested Changes
+-----------------
+
+Describe what changes you suggest:
+
+- [ ] Clarify existing content
+- [ ] Add missing information
+- [ ] Fix incorrect information
+- [ ] Improve examples
+- [ ] Fix typos/grammar
+- [ ] Other (please specify)
+
+___
+
+Proposed Text
+-------------
+
+If you have a specific suggestion for new text, please provide it here:
+
+```markdown
+# Your proposed documentation text here
+```
+
+___
+
+Additional Context
+------------------
+
+Any other information or screenshots about the documentation issue.

djapi_guard-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,60 @@
+---
+
+name: Feature request
+about: Suggest an idea for DjangoAPI Guard
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+Is your feature request related to a problem
+=============================================
+
+A clear and concise description of what the problem is. Ex. I'm always facing issues when [...]
+
+___
+
+Describe the solution you'd like
+---------------------------------
+
+A clear and concise description of what you want to happen. Include any API design ideas or examples of how you'd like to use this feature.
+
+___
+
+Describe alternatives you've considered
+---------------------------------------
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+___
+
+Example Implementation
+----------------------
+
+If possible, provide a pseudocode example of how this feature might be implemented or used:
+
+```python
+# Example code showing how you'd like to use this feature
+# settings.py
+MIDDLEWARE = [
+    "djangoapi_guard.middleware.DjangoAPIGuardMiddleware",
+    # ...
+]
+
+DJANGOAPI_GUARD = {
+    "new_feature": {
+        # Your feature configuration here
+    }
+}
+```
+
+___
+
+Additional context
+------------------
+
+Add any other context or screenshots about the feature request here:
+
+- How would this benefit the community?
+- Are there similar implementations in other libraries that could be referenced?
+- Would this require changes to existing APIs?

djapi_guard-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,66 @@
+Description
+===========
+
+<!--- Describe your changes in detail -->
+
+___
+
+Related Issue
+-------------
+
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+Fixes #
+
+___
+
+Motivation and Context
+----------------------
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If adding a new feature, please describe the motivation for it -->
+
+___
+
+Type of change
+--------------
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation change
+- [ ] Performance improvement
+- [ ] Code cleanup or refactoring
+
+___
+
+How Has This Been Tested
+-------------------------
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+___
+
+Screenshots (if appropriate)
+-----------------------------
+
+___
+
+Checklist
+---------
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My code follows the code style of this project (Mypy, Ruff)
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed
+- [ ] My change requires a change to the documentation
+- [ ] I have updated the documentation accordingly
+- [ ] I have checked that my changes don't introduce any new warnings or errors
+- [ ] I have updated the version number if necessary
+- [ ] I have added any new dependencies to the appropriate requirements file

djapi_guard-1.0.0/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+    allow:
+      - dependency-type: "all"

djapi_guard-1.0.0/.github/scripts/bump_version.py

@@ -0,0 +1,319 @@
+"""
+Version bump helper script for djapi-guard.
+
+Updates the version string across all files that reference it:
+- pyproject.toml
+- .mike.yml
+- docs/versions/versions.json
+- docs/index.md
+- CHANGELOG.md
+- docs/release-notes.md
+
+Usage:
+    python .github/scripts/bump_version.py <version>
+    make bump-version VERSION=x.y.z
+
+No external dependencies required — stdlib only.
+"""
+
+from __future__ import annotations
+
+import json
+import re
+import sys
+from collections.abc import Callable
+from datetime import datetime, timezone
+from pathlib import Path
+
+# Resolve project root relative to this script's location
+PROJECT_ROOT = Path(__file__).resolve().parent.parent.parent
+
+VERSION_PATTERN = re.compile(r"^\d+\.\d+\.\d+$")
+
+
+def parse_semver(version: str) -> tuple[int, ...]:
+    """Parse a semver string into a comparable tuple."""
+    return tuple(int(part) for part in version.split("."))
+
+
+def is_latest(new_version: str, existing_versions: list[str]) -> bool:
+    """Return True if new_version is >= all existing versions."""
+    new_parsed = parse_semver(new_version)
+    for v in existing_versions:
+        try:
+            if parse_semver(v) > new_parsed:
+                return False
+        except ValueError:
+            continue
+    return True
+
+
+def sorted_versions_descending(versions: list[str]) -> list[str]:
+    """Sort version strings in descending semver order."""
+    semver_versions = []
+    non_semver = []
+    for v in versions:
+        try:
+            semver_versions.append((parse_semver(v), v))
+        except ValueError:
+            non_semver.append(v)
+    semver_versions.sort(reverse=True)
+    return [v for _, v in semver_versions] + non_semver
+
+
+def update_pyproject_toml(version: str) -> bool:
+    """Update version in pyproject.toml."""
+    path = PROJECT_ROOT / "pyproject.toml"
+    content = path.read_text()
+    pattern = re.compile(r'^(version\s*=\s*)"[^"]*"', re.MULTILINE)
+    match = pattern.search(content)
+    if not match:
+        print("  ERROR: Could not find version field in pyproject.toml")
+        return False
+    current = re.search(r'"([^"]*)"', match.group(0))
+    if current and current.group(1) == version:
+        print(f"  pyproject.toml: already set to {version}")
+        return True
+    new_content = pattern.sub(f'{match.group(1)}"{version}"', content)
+    path.write_text(new_content)
+    print(f"  pyproject.toml: updated to {version}")
+    return True
+
+
+def update_mike_yml(version: str) -> bool:
+    """Update .mike.yml with new version entry and latest alias."""
+    path = PROJECT_ROOT / ".mike.yml"
+    content = path.read_text()
+    lines = content.splitlines()
+
+    # Extract existing versions from the versions list
+    existing_versions: list[str] = []
+    versions_start = -1
+    versions_end = -1
+    in_versions = False
+    for i, line in enumerate(lines):
+        if line.startswith("versions:"):
+            versions_start = i
+            in_versions = True
+            continue
+        if in_versions:
+            stripped = line.strip()
+            if stripped.startswith("- "):
+                entry = stripped[2:].strip()
+                existing_versions.append(entry)
+                versions_end = i
+            else:
+                break
+
+    if versions_start == -1:
+        print("  ERROR: Could not find versions list in .mike.yml")
+        return False
+
+    # Check if version already exists
+    if version in existing_versions:
+        print(f"  .mike.yml: version {version} already present")
+    else:
+        # Build new versions list: semver versions sorted descending, then "latest"
+        semver_versions = [v for v in existing_versions if v != "latest"]
+        semver_versions.append(version)
+        sorted_versions = sorted_versions_descending(semver_versions)
+        if "latest" in existing_versions:
+            sorted_versions.append("latest")
+
+        # Rebuild the versions block
+        new_version_lines = [f"  - {v}" for v in sorted_versions]
+        lines = (
+            lines[: versions_start + 1] + new_version_lines + lines[versions_end + 1 :]
+        )
+        print(f"  .mike.yml: added version {version}")
+
+    # Update the latest alias if this is the newest version
+    semver_only = [v for v in existing_versions + [version] if v != "latest"]
+    if is_latest(version, semver_only):
+        alias_pattern = re.compile(r"^(\s*latest:\s*).+$")
+        for i, line in enumerate(lines):
+            match = alias_pattern.match(line)
+            if match:
+                if line.strip() == f"latest: {version}":
+                    print(f"  .mike.yml: latest alias already points to {version}")
+                else:
+                    lines[i] = f"  latest: {version}"
+                    print(f"  .mike.yml: updated latest alias to {version}")
+                break
+
+    path.write_text("\n".join(lines) + "\n")
+    return True
+
+
+def update_versions_json(version: str) -> bool:
+    """Update docs/versions/versions.json."""
+    path = PROJECT_ROOT / "docs" / "versions" / "versions.json"
+    data: dict[str, str] = json.loads(path.read_text())
+
+    if version in data and data.get("latest") == version:
+        print(f"  versions.json: already contains {version}")
+        return True
+
+    changed = False
+    if version not in data:
+        data[version] = version
+        changed = True
+        print(f"  versions.json: added {version}")
+
+    # Determine if this is the latest
+    semver_keys = [k for k in data if k != "latest"]
+    if is_latest(version, semver_keys):
+        if data.get("latest") != version:
+            data["latest"] = version
+            changed = True
+            print(f"  versions.json: updated latest to {version}")
+
+    if not changed:
+        print(f"  versions.json: already up to date for {version}")
+        return True
+
+    # Sort: semver keys descending, then "latest" at the end
+    semver_keys = [k for k in data if k != "latest"]
+    sorted_keys = sorted_versions_descending(semver_keys)
+    if "latest" in data:
+        sorted_keys.append("latest")
+
+    ordered: dict[str, str] = {k: data[k] for k in sorted_keys}
+    path.write_text(json.dumps(ordered, indent=4) + "\n")
+    return True
+
+
+def update_index_md(version: str) -> bool:
+    """Update docker pull version tag in docs/index.md."""
+    path = PROJECT_ROOT / "docs" / "index.md"
+    content = path.read_text()
+
+    pattern = re.compile(
+        r"(docker pull ghcr\.io/rennf93/djapi-guard-example:v)"
+        r"[\d]+\.[\d]+\.[\d]+"
+    )
+    match = pattern.search(content)
+    if not match:
+        print("  docs/index.md: no docker pull version tag found, skipping")
+        return True
+
+    current_version = match.group(0).split(":v")[-1]
+    if current_version == version:
+        print(f"  docs/index.md: already set to v{version}")
+        return True
+
+    # Only update if this is the latest version
+    # We check against pyproject.toml's current version as reference
+    pyproject = PROJECT_ROOT / "pyproject.toml"
+    pyproject_content = pyproject.read_text()
+    pyproject_match = re.search(
+        r'^version\s*=\s*"([^"]*)"', pyproject_content, re.MULTILINE
+    )
+    existing_versions = [pyproject_match.group(1)] if pyproject_match else []
+    existing_versions.append(current_version)
+
+    if not is_latest(version, existing_versions):
+        print(f"  docs/index.md: {version} is not latest, skipping docker tag update")
+        return True
+
+    new_content = pattern.sub(f"\\g<1>{version}", content)
+    path.write_text(new_content)
+    print(f"  docs/index.md: updated docker tag to v{version}")
+    return True
+
+
+def _insert_changelog_scaffold(path: Path, version: str, label: str) -> bool:
+    """Insert a version scaffold block into a changelog file."""
+    content = path.read_text()
+    today = datetime.now(tz=timezone.utc).strftime("%Y-%m-%d")
+    header = f"v{version} ({today})"
+
+    # Check if this version already has an entry
+    if f"v{version} (" in content:
+        print(f"  {label}: v{version} entry already exists")
+        return True
+
+    scaffold = (
+        f"{header}\n"
+        f"-------------------\n"
+        f"\n"
+        f"TITLE (v{version})\n"
+        f"------------\n"
+        f"\n"
+        f"CONTENT\n"
+        f"\n"
+        f"___\n"
+        f"\n"
+    )
+
+    # Find the first existing version entry to insert before it
+    version_header_pattern = re.compile(r"^v\d+\.\d+\.\d+ \(", re.MULTILINE)
+    match = version_header_pattern.search(content)
+    if match:
+        insert_pos = match.start()
+        new_content = content[:insert_pos] + scaffold + content[insert_pos:]
+    else:
+        # No existing entries — append at end
+        new_content = content.rstrip() + "\n\n" + scaffold
+
+    path.write_text(new_content)
+    print(f"  {label}: added v{version} scaffold")
+    return True
+
+
+def update_changelogs(version: str) -> bool:
+    """Update CHANGELOG.md and docs/release-notes.md."""
+    changelog = PROJECT_ROOT / "CHANGELOG.md"
+    release_notes = PROJECT_ROOT / "docs" / "release-notes.md"
+
+    ok = True
+    ok = _insert_changelog_scaffold(changelog, version, "CHANGELOG.md") and ok
+    ok = (
+        _insert_changelog_scaffold(release_notes, version, "docs/release-notes.md")
+        and ok
+    )
+    return ok
+
+
+def main() -> int:
+    if len(sys.argv) != 2:
+        print("Usage: bump_version.py <version>")
+        print("  version must be in X.Y.Z format")
+        return 1
+
+    version = sys.argv[1]
+
+    if not VERSION_PATTERN.match(version):
+        print(f"Error: '{version}' is not a valid version. Expected format: X.Y.Z")
+        return 1
+
+    print(f"Bumping version to {version}...\n")
+
+    updaters: list[tuple[str, Callable[[str], bool]]] = [
+        ("pyproject.toml", update_pyproject_toml),
+        (".mike.yml", update_mike_yml),
+        ("docs/versions/versions.json", update_versions_json),
+        ("docs/index.md", update_index_md),
+        ("changelogs", update_changelogs),
+    ]
+
+    all_ok = True
+    for name, updater in updaters:
+        try:
+            if not updater(version):
+                print(f"\n  FAILED: {name}")
+                all_ok = False
+        except Exception as e:
+            print(f"\n  ERROR updating {name}: {e}")
+            all_ok = False
+
+    print()
+    if all_ok:
+        print("Version bump complete.")
+    else:
+        print("Version bump completed with errors.")
+    return 0 if all_ok else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())