django-ninja-aio-crud 2.2.0__tar.gz → 2.3.1__tar.gz

{django_ninja_aio_crud-2.2.0 → django_ninja_aio_crud-2.3.1}/.github/workflows/docs.yml

@@ -13,6 +13,8 @@ on:
           - stable
           - "1.0"
           - "2.0"
+          - "2.2"
+          - "2.3"
       make_latest:
         description: 'Set as "latest" and default?'
         type: boolean
@@ -29,6 +31,8 @@ on:
           - stable
           - "1.0"
           - "2.0"
+          - "2.2"
+          - "2.3"
       delete_confirm:
         description: 'Confirm deletion of the selected version'
         type: boolean

{django_ninja_aio_crud-2.2.0 → django_ninja_aio_crud-2.3.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.2.0
+Version: 2.3.1
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
-Requires-Python: >=3.10, <=3.14
+Requires-Python: >=3.10, <3.15
 Description-Content-Type: text/markdown
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
@@ -74,6 +74,7 @@ Add to your project’s dependencies and ensure Django Ninja is installed.
 ## 🚀 Quick Start
 
 models.py
+
 ```python
 from django.db import models
 from ninja_aio.models import ModelSerializer
@@ -93,6 +94,7 @@ class Book(ModelSerializer):
 ```
 
 views.py
+
 ```python
 from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
@@ -100,11 +102,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 +115,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):
@@ -128,6 +128,7 @@ class BookViewSet(APIViewSet):
 ```
 
 Request:
+
 ```
 GET /book/?published=true&title=python
 ```
@@ -151,9 +152,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,10 +168,10 @@ class ArticleViewSet(APIViewSet):
             queryset = queryset.filter(name__icontains=n)
         return queryset
 
-ArticleViewSet().add_views_to_route()
 ```
 
 Endpoints:
+
 - `GET /article/{pk}/tag?name=dev`
 - `POST /article/{pk}/tag/` body: `{"add":[1,2],"remove":[3]}`
 
@@ -195,9 +195,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
 ```
@@ -207,6 +206,7 @@ class SecureBookViewSet(APIViewSet):
 ## 📑 Lifecycle Hooks (ModelSerializer)
 
 Available on every save/delete:
+
 - `on_create_before_save`
 - `on_create_after_save`
 - `before_save`
@@ -220,10 +220,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):
@@ -244,9 +255,8 @@ class LargePagination(PageNumberPagination):
     page_size = 50
     max_page_size = 200
 
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
     pagination_class = LargePagination
 ```
 
@@ -255,6 +265,7 @@ class BookViewSet(APIViewSet):
 ## 🛠 Project Structure & Docs
 
 Documentation (MkDocs + Material):
+
 ```
 docs/
   getting_started/
@@ -267,17 +278,19 @@ docs/
 ```
 
 Browse full reference:
+
 - APIViewSet: `docs/api/views/api_view_set.md`
 - APIView: `docs/api/views/api_view.md`
 - ModelSerializer: `docs/api/models/model_serializer.md`
 - Authentication: `docs/api/authentication.md`
-- Pagination: `docs/api/pagination.md`
+- Example repository: https://github.com/caspel26/ninja-aio-blog-example
 
 ---
 
 ## 🧪 Tests
 
 Use Django test runner + async ORM patterns. Example async pattern:
+
 ```python
 obj = await Book.objects.acreate(title="T1", published=True)
 count = await Book.objects.acount()
@@ -288,9 +301,8 @@ count = await Book.objects.acount()
 ## 🚫 Disable Operations
 
 ```python
+@api.viewset(Book)
 class ReadOnlyBookViewSet(APIViewSet):
-    model = Book
-    api = api
     disable = ["update", "delete"]
 ```
 
@@ -318,6 +330,7 @@ class ReadOnlyBookViewSet(APIViewSet):
 ## ⭐ Support
 
 Star the repo or donate:
+
 - [Buy me a coffee](https://buymeacoffee.com/caspel26)
 
 ---
@@ -330,11 +343,12 @@ MIT License. See [LICENSE](LICENSE).
 
 ## 🔗 Quick Links
 
-| Item | Link |
-|------|------|
-| PyPI | https://pypi.org/project/django-ninja-aio-crud/ |
-| Docs | https://django-ninja-aio.com
-| Issues | https://github.com/caspel26/django-ninja-aio-crud/issues |
+| Item    | Link                                                     |
+| ------- | -------------------------------------------------------- |
+| PyPI    | https://pypi.org/project/django-ninja-aio-crud/          |
+| Docs    | https://django-ninja-aio.com                             |
+| Issues  | https://github.com/caspel26/django-ninja-aio-crud/issues |
+| Example | https://github.com/caspel26/ninja-aio-blog-example       |
 
 ---
 

{django_ninja_aio_crud-2.2.0 → django_ninja_aio_crud-2.3.1}/README.md

@@ -39,6 +39,7 @@ Add to your project’s dependencies and ensure Django Ninja is installed.
 ## 🚀 Quick Start
 
 models.py
+
 ```python
 from django.db import models
 from ninja_aio.models import ModelSerializer
@@ -58,6 +59,7 @@ class Book(ModelSerializer):
 ```
 
 views.py
+
 ```python
 from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
@@ -65,11 +67,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 +80,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):
@@ -93,6 +93,7 @@ class BookViewSet(APIViewSet):
 ```
 
 Request:
+
 ```
 GET /book/?published=true&title=python
 ```
@@ -116,9 +117,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,10 +133,10 @@ class ArticleViewSet(APIViewSet):
             queryset = queryset.filter(name__icontains=n)
         return queryset
 
-ArticleViewSet().add_views_to_route()
 ```
 
 Endpoints:
+
 - `GET /article/{pk}/tag?name=dev`
 - `POST /article/{pk}/tag/` body: `{"add":[1,2],"remove":[3]}`
 
@@ -160,9 +160,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
 ```
@@ -172,6 +171,7 @@ class SecureBookViewSet(APIViewSet):
 ## 📑 Lifecycle Hooks (ModelSerializer)
 
 Available on every save/delete:
+
 - `on_create_before_save`
 - `on_create_after_save`
 - `before_save`
@@ -185,10 +185,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):
@@ -209,9 +220,8 @@ class LargePagination(PageNumberPagination):
     page_size = 50
     max_page_size = 200
 
+@api.viewset(Book)
 class BookViewSet(APIViewSet):
-    model = Book
-    api = api
     pagination_class = LargePagination
 ```
 
@@ -220,6 +230,7 @@ class BookViewSet(APIViewSet):
 ## 🛠 Project Structure & Docs
 
 Documentation (MkDocs + Material):
+
 ```
 docs/
   getting_started/
@@ -232,17 +243,19 @@ docs/
 ```
 
 Browse full reference:
+
 - APIViewSet: `docs/api/views/api_view_set.md`
 - APIView: `docs/api/views/api_view.md`
 - ModelSerializer: `docs/api/models/model_serializer.md`
 - Authentication: `docs/api/authentication.md`
-- Pagination: `docs/api/pagination.md`
+- Example repository: https://github.com/caspel26/ninja-aio-blog-example
 
 ---
 
 ## 🧪 Tests
 
 Use Django test runner + async ORM patterns. Example async pattern:
+
 ```python
 obj = await Book.objects.acreate(title="T1", published=True)
 count = await Book.objects.acount()
@@ -253,9 +266,8 @@ count = await Book.objects.acount()
 ## 🚫 Disable Operations
 
 ```python
+@api.viewset(Book)
 class ReadOnlyBookViewSet(APIViewSet):
-    model = Book
-    api = api
     disable = ["update", "delete"]
 ```
 
@@ -283,6 +295,7 @@ class ReadOnlyBookViewSet(APIViewSet):
 ## ⭐ Support
 
 Star the repo or donate:
+
 - [Buy me a coffee](https://buymeacoffee.com/caspel26)
 
 ---
@@ -295,10 +308,11 @@ MIT License. See [LICENSE](LICENSE).
 
 ## 🔗 Quick Links
 
-| Item | Link |
-|------|------|
-| PyPI | https://pypi.org/project/django-ninja-aio-crud/ |
-| Docs | https://django-ninja-aio.com
-| Issues | https://github.com/caspel26/django-ninja-aio-crud/issues |
+| Item    | Link                                                     |
+| ------- | -------------------------------------------------------- |
+| PyPI    | https://pypi.org/project/django-ninja-aio-crud/          |
+| Docs    | https://django-ninja-aio.com                             |
+| Issues  | https://github.com/caspel26/django-ninja-aio-crud/issues |
+| Example | https://github.com/caspel26/ninja-aio-blog-example       |
 
 ---

{django_ninja_aio_crud-2.2.0 → django_ninja_aio_crud-2.3.1}/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,7 +126,7 @@ Registers all defined views to the API instance.
 
 **Returns:** The router instance
 
-**Note:** When using `@api.view(prefix="/path", tags=[...])`, manual registration via `add_views_to_route()` is not required; the router is mounted automatically.
+**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
 
@@ -90,6 +135,7 @@ Registers all defined views to the API instance.
 ```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")
@@ -100,14 +146,13 @@ class StatsSchema(Schema):
 
 @api.view(prefix="/analytics", tags=["Analytics"])
 class AnalyticsView(APIView):
-    def views(self):
-        @self.router.get("/dashboard", response=StatsSchema)
-        async def dashboard(request):
-            return {"total": 1000, "active": 750}
+    @api_get("/dashboard", response=StatsSchema)
+    async def dashboard(self, request):
+        return {"total": 1000, "active": 750}
 
-        @self.router.post("/track")
-        async def track_event(request, event: str):
-            return {"tracked": event}
+    @api_post("/track")
+    async def track_event(self, request, event: str):
+        return {"tracked": event}
 ```
 
 **Alternative implementation:**
@@ -138,6 +183,7 @@ AnalyticsView().add_views_to_route()
 - 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: