django-ninja-aio-crud 2.1.0__tar.gz → 2.3.0__tar.gz

{django_ninja_aio_crud-2.1.0 → django_ninja_aio_crud-2.3.0}/.github/workflows/docs.yml

@@ -13,6 +13,7 @@ on:
           - stable
           - "1.0"
           - "2.0"
+          - "2.2"
       make_latest:
         description: 'Set as "latest" and default?'
         type: boolean
@@ -29,6 +30,7 @@ on:
           - stable
           - "1.0"
           - "2.0"
+          - "2.2"
       delete_confirm:
         description: 'Confirm deletion of the selected version'
         type: boolean
@@ -96,7 +98,7 @@ jobs:
           if [ "$MAKE_LATEST" = "true" ]; then
             echo "Deploying $VERSION as latest and default"
             mike deploy --push --update-aliases "$VERSION" latest --ignore-remote-status
-            mike set-default "$VERSION"
+            mike set-default --push latest
           else
             echo "Deploying $VERSION (non-latest)"
             mike deploy --push "$VERSION" --ignore-remote-status

{django_ninja_aio_crud-2.1.0 → django_ninja_aio_crud-2.3.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.1.0
+Version: 2.3.0
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
-Requires-Python: >=3.10
+Requires-Python: >=3.10, <=3.14
 Description-Content-Type: text/markdown
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
@@ -100,11 +100,10 @@ from .models import Book
 
 api = NinjaAIO()
 
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
+    pass
 
-BookViewSet().add_views_to_route()
 ```
 
 Visit `/docs` → CRUD endpoints ready.
@@ -114,9 +113,8 @@ Visit `/docs` → CRUD endpoints ready.
 ## 🔄 Query Filtering
 
 ```python
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
     query_params = {"published": (bool, None), "title": (str, None)}
 
     async def query_params_handler(self, queryset, filters):
@@ -151,9 +149,8 @@ class Article(ModelSerializer):
     class ReadSerializer:
         fields = ["id", "title", "tags"]
 
+@api.viewset(Article)
 class ArticleViewSet(APIViewSet):
-    model = Article
-    api = api
     m2m_relations = [
         M2MRelationSchema(
             model=Tag,
@@ -168,7 +165,6 @@ class ArticleViewSet(APIViewSet):
             queryset = queryset.filter(name__icontains=n)
         return queryset
 
-ArticleViewSet().add_views_to_route()
 ```
 
 Endpoints:
@@ -195,9 +191,8 @@ class JWTAuth(AsyncJwtBearer):
         book_id = self.dcd.claims.get("sub")
         return await Book.objects.aget(id=book_id)
 
+@api.viewset(Book)
 class SecureBookViewSet(APIViewSet):
-    model = Book
-    api = api
     auth = [JWTAuth()]
     get_auth = None  # list/retrieve public
 ```
@@ -220,10 +215,21 @@ Available on every save/delete:
 ## 🧩 Adding Custom Endpoints
 
 ```python
+from ninja_aio.decorators import api_get
+
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
+    @api_get("/stats/")
+    async def stats(self, request):
+        total = await Book.objects.acount()
+        return {"total": total}
+```
+
+Or
 
+```python
+@api.viewset(Book)
+class BookViewSet(APIViewSet):
     def views(self):
         @self.router.get("/stats/")
         async def stats(request):
@@ -288,9 +294,8 @@ count = await Book.objects.acount()
 ## 🚫 Disable Operations
 
 ```python
+@api.viewset(Book)
 class ReadOnlyBookViewSet(APIViewSet):
-    model = Book
-    api = api
     disable = ["update", "delete"]
 ```
 

{django_ninja_aio_crud-2.1.0 → django_ninja_aio_crud-2.3.0}/README.md

@@ -65,11 +65,10 @@ from .models import Book
 
 api = NinjaAIO()
 
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
+    pass
 
-BookViewSet().add_views_to_route()
 ```
 
 Visit `/docs` → CRUD endpoints ready.
@@ -79,9 +78,8 @@ Visit `/docs` → CRUD endpoints ready.
 ## 🔄 Query Filtering
 
 ```python
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
     query_params = {"published": (bool, None), "title": (str, None)}
 
     async def query_params_handler(self, queryset, filters):
@@ -116,9 +114,8 @@ class Article(ModelSerializer):
     class ReadSerializer:
         fields = ["id", "title", "tags"]
 
+@api.viewset(Article)
 class ArticleViewSet(APIViewSet):
-    model = Article
-    api = api
     m2m_relations = [
         M2MRelationSchema(
             model=Tag,
@@ -133,7 +130,6 @@ class ArticleViewSet(APIViewSet):
             queryset = queryset.filter(name__icontains=n)
         return queryset
 
-ArticleViewSet().add_views_to_route()
 ```
 
 Endpoints:
@@ -160,9 +156,8 @@ class JWTAuth(AsyncJwtBearer):
         book_id = self.dcd.claims.get("sub")
         return await Book.objects.aget(id=book_id)
 
+@api.viewset(Book)
 class SecureBookViewSet(APIViewSet):
-    model = Book
-    api = api
     auth = [JWTAuth()]
     get_auth = None  # list/retrieve public
 ```
@@ -185,10 +180,21 @@ Available on every save/delete:
 ## 🧩 Adding Custom Endpoints
 
 ```python
+from ninja_aio.decorators import api_get
+
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
+    @api_get("/stats/")
+    async def stats(self, request):
+        total = await Book.objects.acount()
+        return {"total": total}
+```
+
+Or
 
+```python
+@api.viewset(Book)
+class BookViewSet(APIViewSet):
     def views(self):
         @self.router.get("/stats/")
         async def stats(request):
@@ -253,9 +259,8 @@ count = await Book.objects.acount()
 ## 🚫 Disable Operations
 
 ```python
+@api.viewset(Book)
 class ReadOnlyBookViewSet(APIViewSet):
-    model = Book
-    api = api
     disable = ["update", "delete"]
 ```
 

{django_ninja_aio_crud-2.1.0 → django_ninja_aio_crud-2.3.0}/docs/api/authentication.md

@@ -614,188 +614,11 @@ Support both JWT and API Key:
 class ArticleViewSet(APIViewSet):
     model = Article
     api = api
-    auth = [JWTAuth() | APIKeyAuth()]  # Either JWT or API Key
+    auth = [JWTAuth(), APIKeyAuth()]  # Either JWT or API Key
 ```
 
 Django Ninja will try both methods; if either succeeds, the request is authenticated.
 
-## Token Validation
-
-### Expiration Validation
-
-JWT tokens include `exp` claim (expiration timestamp):
-
-```python
-# Token payload
-{
-  "sub": "123",
-  "exp": 1704067200,  # Unix timestamp
-  "iat": 1704063600
-}
-```
-
-AsyncJwtBearer automatically validates expiration:
-
-```python
-class JWTAuth(AsyncJwtBearer):
-    jwt_public = jwk.RSAKey.import_key(PUBLIC_KEY)
-    # Expiration checked automatically
-```
-
-**Error Response:**
-
-```json
-{
-  "detail": "Token has expired"
-}
-```
-
-### Not Before Validation
-
-Use `nbf` claim for tokens that become valid in the future:
-
-```python
-# Token payload
-{
-  "sub": "123",
-  "nbf": 1704063600,  # Not valid before this time
-  "exp": 1704067200
-}
-```
-
-Automatically validated by AsyncJwtBearer.
-
-### Custom Validation
-
-```python
-class StrictAuth(AsyncJwtBearer):
-    jwt_public = jwk.RSAKey.import_key(PUBLIC_KEY)
-
-    async def auth_handler(self, request):
-        # Check token type
-        token_type = self.dcd.claims.get("typ")
-        if token_type != "access":
-            return False
-
-        # Check IP whitelist
-        allowed_ips = self.dcd.claims.get("allowed_ips", [])
-        client_ip = request.META.get('REMOTE_ADDR')
-        if allowed_ips and client_ip not in allowed_ips:
-            return False
-
-        # Continue with normal auth
-        user_id = self.dcd.claims.get("sub")
-        return await User.objects.aget(id=user_id)
-```
-
-## Testing Authentication
-
-### Unit Tests
-
-```python
-import pytest
-from ninja.testing import TestAsyncClient
-from myapp.views import api
-from myapp.auth import JWTAuth
-import jwt
-from datetime import datetime, timedelta
-
-
-def create_token(user_id: int, **claims) -> str:
-    payload = {
-        "sub": str(user_id),
-        "exp": datetime.utcnow() + timedelta(hours=1),
-        "iat": datetime.utcnow(),
-        **claims
-    }
-    return jwt.encode(payload, PRIVATE_KEY, algorithm="RS256")
-
-
-@pytest.mark.asyncio
-async def test_authenticated_request():
-    client = TestAsyncClient(api)
-
-    # Create user
-    user = await User.objects.acreate(username="testuser")
-
-    # Create token
-    token = create_token(user.id)
-
-    # Make authenticated request
-    response = await client.get(
-        "/article/",
-        headers={"Authorization": f"Bearer {token}"}
-    )
-
-    assert response.status_code == 200
-
-
-@pytest.mark.asyncio
-async def test_missing_token():
-    client = TestAsyncClient(api)
-
-    response = await client.get("/article/")
-    assert response.status_code == 401
-    assert "detail" in response.json()
-
-
-@pytest.mark.asyncio
-async def test_expired_token():
-    client = TestAsyncClient(api)
-
-    # Create expired token
-    payload = {
-        "sub": "123",
-        "exp": datetime.utcnow() - timedelta(hours=1),  # Expired
-        "iat": datetime.utcnow() - timedelta(hours=2)
-    }
-    token = jwt.encode(payload, PRIVATE_KEY, algorithm="RS256")
-
-    response = await client.get(
-        "/article/",
-        headers={"Authorization": f"Bearer {token}"}
-    )
-
-    assert response.status_code == 401
-
-
-@pytest.mark.asyncio
-async def test_invalid_signature():
-    client = TestAsyncClient(api)
-
-    # Create token with wrong key
-    payload = {"sub": "123", "exp": datetime.utcnow() + timedelta(hours=1)}
-    token = jwt.encode(payload, "wrong-secret", algorithm="HS256")
-
-    response = await client.get(
-        "/article/",
-        headers={"Authorization": f"Bearer {token}"}
-    )
-
-    assert response.status_code == 401
-```
-
-### Mock Authentication
-
-For testing without real tokens:
-
-```python
-from unittest.mock import AsyncMock, patch
-
-
-@pytest.mark.asyncio
-@patch('myapp.auth.JWTAuth.auth_handler')
-async def test_with_mock_auth(mock_auth):
-    # Mock auth to return test user
-    user = await User.objects.acreate(username="testuser")
-    mock_auth.return_value = user
-
-    client = TestAsyncClient(api)
-    response = await client.get("/article/")
-
-    assert response.status_code == 200
-```
-
 ## Best Practices
 
 1. **Use RSA (asymmetric) keys for production:**

{django_ninja_aio_crud-2.1.0 → django_ninja_aio_crud-2.3.0}/docs/api/views/api_view.md

@@ -31,9 +31,54 @@ class APIView:
 
 ## Methods
 
-### `views()`
+### Recommended: decorator-based endpoints
 
-Override this method to define your custom endpoints.
+Prefer class method decorators to define non-CRUD endpoints. Decorators lazily bind instance methods to the router and automatically remove `self` from the OpenAPI signature while preserving type hints.
+
+Available decorators (from `ninja_aio.decorators`):
+
+- `@api_get(path, ...)`
+- `@api_post(path, ...)`
+- `@api_put(path, ...)`
+- `@api_patch(path, ...)`
+- `@api_delete(path, ...)`
+- `@api_options(path, ...)`
+- `@api_head(path, ...)`
+
+Example:
+
+```python
+from ninja_aio import NinjaAIO
+from ninja_aio.views import APIView
+from ninja_aio.decorators import api_get, api_post
+from ninja import Schema
+
+api = NinjaAIO(title="My API")
+
+class StatsSchema(Schema):
+    total: int
+    active: int
+
+@api.view(prefix="/analytics", tags=["Analytics"])
+class AnalyticsView(APIView):
+    @api_get("/dashboard", response=StatsSchema)
+    async def dashboard(self, request):
+        return {"total": 1000, "active": 750}
+
+    @api_post("/track")
+    async def track_event(self, request, event: str):
+        return {"tracked": event}
+```
+
+Notes:
+
+- Decorators support per-endpoint `auth`, `response`, `tags`, `summary`, `description`, throttling, and OpenAPI extras.
+- Sync methods run via `sync_to_async` automatically.
+- `self` is excluded from the exposed signature; parameter type hints are preserved.
+
+### Legacy: `views()` (still supported)
+
+You can still override `views()` to define endpoints imperatively.
 
 **Example - Basic Views:**
 
@@ -81,18 +126,16 @@ Registers all defined views to the API instance.
 
 **Returns:** The router instance
 
-**Usage:**
-
-```python
-view = UserAPIView()
-view.add_views_to_route()
-```
+**Note:** When using `@api.view(prefix="/path", tags=[...])`, the router is mounted automatically and decorator-based endpoints are registered lazily on instantiation; manual registration via `add_views_to_route()` is not required.
 
 ## Complete Example
 
+**Recommended:**
+
 ```python
 from ninja_aio import NinjaAIO
 from ninja_aio.views import APIView
+from ninja_aio.decorators import api_get, api_post
 from ninja import Schema
 
 api = NinjaAIO(title="My API")
@@ -101,6 +144,22 @@ class StatsSchema(Schema):
     total: int
     active: int
 
+@api.view(prefix="/analytics", tags=["Analytics"])
+class AnalyticsView(APIView):
+    @api_get("/dashboard", response=StatsSchema)
+    async def dashboard(self, request):
+        return {"total": 1000, "active": 750}
+
+    @api_post("/track")
+    async def track_event(self, request, event: str):
+        return {"tracked": event}
+```
+
+**Alternative implementation:**
+
+```python
+api = NinjaAIO(title="My API")
+
 class AnalyticsView(APIView):
     api = api
     router_tag = "Analytics"
@@ -109,26 +168,22 @@ class AnalyticsView(APIView):
     def views(self):
         @self.router.get("/dashboard", response=StatsSchema)
         async def dashboard(request):
-            return {
-                "total": 1000,
-                "active": 750
-            }
+            return {"total": 1000, "active": 750}
 
         @self.router.post("/track")
         async def track_event(request, event: str):
-            # tracking logic
             return {"tracked": event}
 
-# Register views
 AnalyticsView().add_views_to_route()
 ```
 
 ## Notes
 
 - Use `APIView` for simple, non-CRUD endpoints
-- For CRUD operations, use [`APIViewSet`](api_view_set.md) instead
-- All views are automatically async-compatible
-- Error codes `{400, 401, 404, 428}` are available via `self.error_codes`
+- For CRUD operations, use [`APIViewSet`](api_view_set.md)
+- All views are async-compatible
+- Standard error codes are available via `self.error_codes`
+- Decorator-based endpoints are preferred for clarity and better OpenAPI signatures.
 
 Note: