jwtninja 0.0.0__tar.gz

jwtninja-0.0.0/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    groups:
+      production-dependencies:
+        dependency-type: "production"
+        update-types: [minor, patch]
+      development-dependencies:
+        dependency-type: "development"
+        update-types: [minor, patch]

jwtninja-0.0.0/.github/release-drafter.yml

@@ -0,0 +1,32 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: '$RESOLVED_VERSION'
+categories:
+  - title: '⚠️ Breaking Changes'
+    labels: [ 'breaking-change' ]
+  - title: '🚀 Features'
+    labels: [ 'breaking-change','feature' ]
+  - title: '🐛 Fixes'
+    labels: [ 'fix' ]
+  - title: '🧰 Maintenance'
+    labels: [ 'maintenance' ]
+  - title: '⚠️ Changes that include Migrations'
+    labels: [ 'migration' ]
+
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&'
+
+version-resolver:
+  major:
+    labels:
+      - 'breaking-change'
+  minor:
+    labels:
+      - 'feature'
+  patch:
+    labels:
+      - 'fix'
+      - 'maintenance'
+  default: patch
+
+template: |
+  $CHANGES

jwtninja-0.0.0/.github/workflows/check-and-test.yml

@@ -0,0 +1,51 @@
+name: Linting, Formatting and Tests
+
+on: [ push ]
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-formatting:
+    name: Check Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - uses: astral-sh/ruff-action@v1
+        with:
+          args: "format --check"
+
+  check-linting:
+    name: Check Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - uses: astral-sh/ruff-action@v1
+        with:
+          args: "check --output-format=github"
+
+  run-tests:
+    name: Run Tests (pytest)
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/astral-sh/uv:python3.12-bookworm-slim
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Install Dependencies
+        run: uv sync --frozen --no-install-project
+
+      - name: "pytest: Run tests"
+        run: .venv/bin/pytest .

jwtninja-0.0.0/.github/workflows/pr-label-checks.yml

@@ -0,0 +1,62 @@
+name: PR Label Checks
+
+on:
+  pull_request:
+    types: [ opened, synchronize, labeled ]
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+  repository-projects: write
+
+jobs:
+  check-labels:
+    name: Check Version Labels and Migrations
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get changed files
+        id: changes
+        run: |
+          git diff --name-only origin/${{ github.event.pull_request.base.ref }} ${{ github.sha }} > changed_files.txt
+          cat changed_files.txt
+
+      - name: Apply "migration" label if migrations detected
+        run: |
+          if grep -q 'migrations/' changed_files.txt; then
+            echo "Migrations detected in the diff. Applying 'migration' label."
+            gh pr edit ${{ github.event.pull_request.number }} --add-label "migration"
+          else
+            echo "No migrations detected."
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check if PR has version labels
+        id: label-check
+        run: |
+          REQUIRED_LABELS=("breaking-change" "feature" "fix" "maintenance")
+          LABELS=$(jq -r '.pull_request.labels[].name' "$GITHUB_EVENT_PATH")
+          echo "Labels on this PR: $LABELS"
+          
+          REQUIRED_LABEL_FOUND=false
+          
+          # Check if any required label is present
+          for label in "${REQUIRED_LABELS[@]}"; do
+            if echo "$LABELS" | grep -q "$label"; then
+              REQUIRED_LABEL_FOUND=true
+              echo "Found required label: $label"
+              break
+            fi
+          done
+          
+          if [ "$REQUIRED_LABEL_FOUND" = false ]; then
+            echo "Error: Pull request must have one of the following labels: ${REQUIRED_LABELS[*]}"
+            exit 1
+          fi
+        shell: bash

jwtninja-0.0.0/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to PyPI (uv)
+
+on:
+  release:
+    types: [published]            
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write             # OIDC → PyPI (token-free)
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.cargo/bin" >> "$GITHUB_PATH"
+
+      # --------------------------------------------------------------
+      # Build sdist & wheels – version is resolved automatically
+      # --------------------------------------------------------------
+      - name: Build distributions
+        run: uv build -o dist/            
+
+      # --------------------------------------------------------------
+      # Publish to PyPI with trusted publishing (OIDC)
+      # --------------------------------------------------------------
+      - name: Publish
+        run: uv publish dist/*            
+        env:
+          UV_PUBLISH_NON_INTERACTIVE: "1" 

jwtninja-0.0.0/.github/workflows/release-drafter.yml

@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: write
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        with:
+          config-name: release-drafter.yml
+          disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jwtninja-0.0.0/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.idea

jwtninja-0.0.0/.python-version

@@ -0,0 +1 @@
+3.12

jwtninja-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Daniel van Flymen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

jwtninja-0.0.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: jwtninja
+Version: 0.0.0
+Summary: A simple and fully-typed auth library for Django Ninja based on PyJWT.
+Project-URL: Homepage, https://github.com/dvf/jwt-ninja
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: django-ninja>=1.3.0
+Requires-Dist: pydantic-settings>=2.5.2
+Requires-Dist: pydantic>=2.9.2
+Requires-Dist: pyjwt>=2.9.0
+Requires-Dist: uuid6>=2024.7.10
+Description-Content-Type: text/markdown
+
+![JWT Ninja Logo](https://github.com/user-attachments/assets/2589db23-94c7-47c6-8687-eb29c6312272) <br/>
+
+# JWT Ninja
+
+*A session‑backed, fully‑typed authentication library for **Django Ninja**, powered by **PyJWT***
+
+[![PyPI](https://img.shields.io/pypi/v/jwtninja.svg)](https://pypi.python.org/pypi/jwtninja)
+[![CI Status](https://github.com/dvf/jwt-ninja/actions/workflows/check-and-test.yml/badge.svg)](https://github.com/dvf/jwt-ninja/actions/workflows/check-and-test.yml)
+[![License](https://img.shields.io/github/license/dvf/jwt-ninja)](LICENSE)
+
+> **❤️ Contributions Welcome!**
+> Whether you’re fixing a bug, or want a new feature, feel free to submit a PR.
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+JWT Ninja is a standard Django app. 
+
+Install it with [uv](https://astral.sh/uv) or `pip`:
+
+```bash
+pip install jwtninja
+```
+
+Add it to **`INSTALLED_APPS`** in `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    ...,
+    "jwt_ninja",
+]
+```
+
+Lastly, don't forget to run migrations:
+
+```bash
+python manage.py migrate
+```
+
+### Usage
+
+Register the built‑in router on your Ninja API:
+
+```python
+from ninja import NinjaAPI
+from jwt_ninja.api import router as auth_router
+from jwt_ninja.errors import APIError as AuthAPIError
+from jwt_ninja.handlers import error_handler
+
+api = NinjaAPI()
+api.add_router("auth/", auth_router)
+
+# Explicit control over how you went errors to be returned
+api.add_exception_handler(AuthAPIError, error_handler)
+```
+
+Endpoints created:
+
+| Method | Path                | Purpose                                         |
+| ------ | ------------------- | ----------------------------------------------- |
+| `POST` | `/auth/login/`      | Issue a new **access** & **refresh** token pair |
+| `POST` | `/auth/refresh/`    | Refresh an access token                         |
+| `GET`  | `/auth/sessions/`   | List active sessions                            |
+| `POST` | `/auth/logout/`     | Log out of the current session                  |
+| `POST` | `/auth/logout/all/` | Log out of **all** sessions                     |
+
+Protect views with `JWTAuth` and enjoy typed requests:
+
+```python
+from ninja import Router
+from jwt_ninja.auth_classes import JWTAuth, AuthedRequest
+
+
+router = Router()
+
+@router.get("/my-protected-endpoint/", auth=JWTAuth())
+def my_protected_route(request: AuthedRequest):
+    request.auth.session.data["foo"] = 123
+    request.auth.session.save()  # Persist session changes
+    return {"message": "Success!"}
+```
+
+---
+
+## ⚙️Settings
+
+```text
+# settings.py defaults
+JWT_SECRET_KEY = SECRET_KEY
+JWT_ALGORITHM = "HS256"
+JWT_ACCESS_TOKEN_EXPIRE_SECONDS = 300        # 5 minutes
+JWT_REFRESH_TOKEN_EXPIRE_SECONDS = 365 * 3600  # 1 year
+JWT_SESSION_EXPIRE_SECONDS = 365 * 3600       # 1 year
+JWT_USER_LOGIN_AUTHENTICATOR = "jwt_ninja.authenticators.django_user_authenticator"
+JWT_PAYLOAD_CLASS = "jwt_ninja.types.JWTPayload"
+```
+
+### Custom Claims
+
+```python
+from jwt_ninja.types import JWTPayload
+
+class CustomJWTPayload(JWTPayload):
+    discord_user_id: str
+    ip_address: str
+    email: str
+```
+
+Configure it:
+
+```python
+JWT_PAYLOAD_CLASS = "path.to.CustomJWTPayload"
+```

jwtninja-0.0.0/README.md

@@ -0,0 +1,116 @@
+![JWT Ninja Logo](https://github.com/user-attachments/assets/2589db23-94c7-47c6-8687-eb29c6312272) <br/>
+
+# JWT Ninja
+
+*A session‑backed, fully‑typed authentication library for **Django Ninja**, powered by **PyJWT***
+
+[![PyPI](https://img.shields.io/pypi/v/jwtninja.svg)](https://pypi.python.org/pypi/jwtninja)
+[![CI Status](https://github.com/dvf/jwt-ninja/actions/workflows/check-and-test.yml/badge.svg)](https://github.com/dvf/jwt-ninja/actions/workflows/check-and-test.yml)
+[![License](https://img.shields.io/github/license/dvf/jwt-ninja)](LICENSE)
+
+> **❤️ Contributions Welcome!**
+> Whether you’re fixing a bug, or want a new feature, feel free to submit a PR.
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+JWT Ninja is a standard Django app. 
+
+Install it with [uv](https://astral.sh/uv) or `pip`:
+
+```bash
+pip install jwtninja
+```
+
+Add it to **`INSTALLED_APPS`** in `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    ...,
+    "jwt_ninja",
+]
+```
+
+Lastly, don't forget to run migrations:
+
+```bash
+python manage.py migrate
+```
+
+### Usage
+
+Register the built‑in router on your Ninja API:
+
+```python
+from ninja import NinjaAPI
+from jwt_ninja.api import router as auth_router
+from jwt_ninja.errors import APIError as AuthAPIError
+from jwt_ninja.handlers import error_handler
+
+api = NinjaAPI()
+api.add_router("auth/", auth_router)
+
+# Explicit control over how you went errors to be returned
+api.add_exception_handler(AuthAPIError, error_handler)
+```
+
+Endpoints created:
+
+| Method | Path                | Purpose                                         |
+| ------ | ------------------- | ----------------------------------------------- |
+| `POST` | `/auth/login/`      | Issue a new **access** & **refresh** token pair |
+| `POST` | `/auth/refresh/`    | Refresh an access token                         |
+| `GET`  | `/auth/sessions/`   | List active sessions                            |
+| `POST` | `/auth/logout/`     | Log out of the current session                  |
+| `POST` | `/auth/logout/all/` | Log out of **all** sessions                     |
+
+Protect views with `JWTAuth` and enjoy typed requests:
+
+```python
+from ninja import Router
+from jwt_ninja.auth_classes import JWTAuth, AuthedRequest
+
+
+router = Router()
+
+@router.get("/my-protected-endpoint/", auth=JWTAuth())
+def my_protected_route(request: AuthedRequest):
+    request.auth.session.data["foo"] = 123
+    request.auth.session.save()  # Persist session changes
+    return {"message": "Success!"}
+```
+
+---
+
+## ⚙️Settings
+
+```text
+# settings.py defaults
+JWT_SECRET_KEY = SECRET_KEY
+JWT_ALGORITHM = "HS256"
+JWT_ACCESS_TOKEN_EXPIRE_SECONDS = 300        # 5 minutes
+JWT_REFRESH_TOKEN_EXPIRE_SECONDS = 365 * 3600  # 1 year
+JWT_SESSION_EXPIRE_SECONDS = 365 * 3600       # 1 year
+JWT_USER_LOGIN_AUTHENTICATOR = "jwt_ninja.authenticators.django_user_authenticator"
+JWT_PAYLOAD_CLASS = "jwt_ninja.types.JWTPayload"
+```
+
+### Custom Claims
+
+```python
+from jwt_ninja.types import JWTPayload
+
+class CustomJWTPayload(JWTPayload):
+    discord_user_id: str
+    ip_address: str
+    email: str
+```
+
+Configure it:
+
+```python
+JWT_PAYLOAD_CLASS = "path.to.CustomJWTPayload"
+```

jwtninja-0.0.0/jwt_ninja/admin.py

@@ -0,0 +1,26 @@
+from django.contrib import admin
+
+from .models import Session
+
+
+@admin.register(Session)
+class SessionAdmin(admin.ModelAdmin):
+    list_display = [
+        "id",
+        "user",
+        "created_at",
+        "updated_at",
+        "expired_at",
+        "ip_address",
+    ]
+    readonly_fields = [
+        "id",
+        "user",
+        "created_at",
+        "updated_at",
+        "expired_at",
+        "ip_address",
+        "data",
+    ]
+    list_filter = ["created_at", "expired_at"]
+    ordering = ["-id"]