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

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

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

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.3.0
+Version: 2.3.2
 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
@@ -25,7 +25,7 @@ Classifier: Framework :: AsyncIO
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
 Classifier: Topic :: Internet :: WWW/HTTP
 License-File: LICENSE
-Requires-Dist: django-ninja >=1.3.0, <=1.5.1
+Requires-Dist: django-ninja >=1.3.0, <1.6
 Requires-Dist: joserfc >=1.0.0, <= 1.4.1
 Requires-Dist: orjson >= 3.10.7, <= 3.11.5
 Requires-Dist: coverage ; extra == "test"
@@ -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
@@ -126,6 +128,7 @@ class BookViewSet(APIViewSet):
 ```
 
 Request:
+
 ```
 GET /book/?published=true&title=python
 ```
@@ -168,6 +171,7 @@ class ArticleViewSet(APIViewSet):
 ```
 
 Endpoints:
+
 - `GET /article/{pk}/tag?name=dev`
 - `POST /article/{pk}/tag/` body: `{"add":[1,2],"remove":[3]}`
 
@@ -202,6 +206,7 @@ class SecureBookViewSet(APIViewSet):
 ## 📑 Lifecycle Hooks (ModelSerializer)
 
 Available on every save/delete:
+
 - `on_create_before_save`
 - `on_create_after_save`
 - `before_save`
@@ -250,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
 ```
 
@@ -261,6 +265,7 @@ class BookViewSet(APIViewSet):
 ## 🛠 Project Structure & Docs
 
 Documentation (MkDocs + Material):
+
 ```
 docs/
   getting_started/
@@ -273,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()
@@ -323,6 +330,7 @@ class ReadOnlyBookViewSet(APIViewSet):
 ## ⭐ Support
 
 Star the repo or donate:
+
 - [Buy me a coffee](https://buymeacoffee.com/caspel26)
 
 ---
@@ -335,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.3.0 → django_ninja_aio_crud-2.3.2}/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
@@ -91,6 +93,7 @@ class BookViewSet(APIViewSet):
 ```
 
 Request:
+
 ```
 GET /book/?published=true&title=python
 ```
@@ -133,6 +136,7 @@ class ArticleViewSet(APIViewSet):
 ```
 
 Endpoints:
+
 - `GET /article/{pk}/tag?name=dev`
 - `POST /article/{pk}/tag/` body: `{"add":[1,2],"remove":[3]}`
 
@@ -167,6 +171,7 @@ class SecureBookViewSet(APIViewSet):
 ## 📑 Lifecycle Hooks (ModelSerializer)
 
 Available on every save/delete:
+
 - `on_create_before_save`
 - `on_create_after_save`
 - `before_save`
@@ -215,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
 ```
 
@@ -226,6 +230,7 @@ class BookViewSet(APIViewSet):
 ## 🛠 Project Structure & Docs
 
 Documentation (MkDocs + Material):
+
 ```
 docs/
   getting_started/
@@ -238,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()
@@ -288,6 +295,7 @@ class ReadOnlyBookViewSet(APIViewSet):
 ## ⭐ Support
 
 Star the repo or donate:
+
 - [Buy me a coffee](https://buymeacoffee.com/caspel26)
 
 ---
@@ -300,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.3.0 → django_ninja_aio_crud-2.3.2}/docs/api/views/decorators.md

@@ -50,9 +50,8 @@ Attach decorators to CRUD operations without redefining views:
 ```python
 from ninja_aio.schemas.helpers import DecoratorsSchema
 
+@api.viewset(MyModel)
 class MyViewSet(APIViewSet):
-    api = api
-    model = MyModel
     extra_decorators = DecoratorsSchema(
         list=[require_auth, cache_page(30)],
         retrieve=[require_auth],

{django_ninja_aio_crud-2.3.0 → django_ninja_aio_crud-2.3.2}/docs/index.md

@@ -33,55 +33,54 @@ Traditional Django REST development requires:
 **Django Ninja Aio CRUD** eliminates this complexity:
 
 === "Traditional Approach"
-    ```python
+    ```python 
     # schema.py
     class UserSchemaOut(ModelSchema)
         class Meta:
-            model = User
-            fields = ['id', 'username', 'email']
-    
+        model = User
+        fields = ['id', 'username', 'email']
+
     class UserSchemaIn(ModelSchema):
         class Meta:
             model = User
             fields = ['username', 'email', 'password']
-    
+
     # views.py
     @api.get("/users", response={200: list[UserSchemaOut]})
     async def list_users(request):
         return [user async for user in User.objects.select_related().all()]
-    
+
     @api.post("/users/", response={201: UserSchemaOut})
     async def create_user(request, data: UserSchemaIn):
         user = await User.objects.select_related().acreate(**data.model_dump())
         return 201, user
 
-    
+
     # ... more views for retrieve, update, delete
     ```
 
 === "Django Ninja Aio CRUD"
-    ```python
+    ```python 
     # models.py
     class User(ModelSerializer):
         username = models.CharField(max_length=150)
         email = models.EmailField()
         password = models.CharField(max_length=128)
-        
+
         class ReadSerializer:
             fields = ["id", "username", "email"]
-        
+
         class CreateSerializer:
             fields = ["username", "email", "password"]
-        
+
         class UpdateSerializer:
             optionals = [("email", str)]
-    
+
     # views.py
+    @api.viewset(User)
     class UserViewSet(APIViewSet):
-        model = User
-        api = api
-    
-    UserViewSet().add_views_to_route()
+        pass
+
     # Done! List, Create, Retrieve, Update, Delete endpoints ready
     ```
 
@@ -213,19 +212,18 @@ from .models import Author, Category, Article, Tag
 api = NinjaAIO(title="Blog API", version="1.0.0")
 
 
+@api.viewset(Author)
 class AuthorViewSet(APIViewSet):
-    model = Author
-    api = api
+    pass
 
 
+@api.viewset(Category)
 class CategoryViewSet(APIViewSet):
-    model = Category
-    api = api
+    pass
 
 
+@api.viewset(Article)
 class ArticleViewSet(APIViewSet):
-    model = Article
-    api = api
     query_params = {
         "is_published": (bool, None),
         "category": (int, None),
@@ -242,16 +240,9 @@ class ArticleViewSet(APIViewSet):
         return queryset
 
 
+@api.viewset(Tag)
 class TagViewSet(APIViewSet):
-    model = Tag
-    api = api
-
-
-# Register all views
-AuthorViewSet().add_views_to_route()
-CategoryViewSet().add_views_to_route()
-ArticleViewSet().add_views_to_route()
-TagViewSet().add_views_to_route()
+    pass
 ```
 
 This creates a complete blog API with:
@@ -287,9 +278,9 @@ class User(ModelSerializer):
 Automatically generates complete CRUD endpoints:
 
 ```python
+@api.viewset(User)
 class UserViewSet(APIViewSet):
-    model = User
-    api = api
+    pass
     # Generates: List, Create, Retrieve, Update, Delete
 ```
 
@@ -298,17 +289,16 @@ class UserViewSet(APIViewSet):
 Extend with custom endpoints:
 
 ```python
+from ninja_aio.decorators import api_post
+
+@api.viewset(User)
 class UserViewSet(APIViewSet):
-    model = User
-    api = api
-
-    def views(self):
-        @self.router.post("/{pk}/activate/")
-        async def activate(request, pk: int):
-            user = await User.objects.aget(pk=pk)
-            user.is_active = True
-            await user.asave()
-            return {"message": "User activated"}
+    @api_post("/{pk}/activate")
+    async def activate(self, request, pk: int):
+        user = await User.objects.aget(pk=pk)
+        user.is_active = True
+        await user.asave()
+        return {"message": "User activated"}
 ```
 
 ## 📄 License
@@ -327,6 +317,7 @@ If you find Django Ninja Aio CRUD useful, consider supporting the project:
 - **GitHub:** [https://github.com/caspel26/django-ninja-aio-crud](https://github.com/caspel26/django-ninja-aio-crud)
 - **PyPI:** [https://pypi.org/project/django-ninja-aio-crud/](https://pypi.org/project/django-ninja-aio-crud/)
 - **Django Ninja:** [https://django-ninja.dev/](https://django-ninja.dev/)
+- **Example repository:** https://github.com/caspel26/ninja-aio-blog-example
 
 ---
 

{django_ninja_aio_crud-2.3.0 → django_ninja_aio_crud-2.3.2}/ninja_aio/__init__.py

@@ -1,6 +1,6 @@
 """Django Ninja AIO CRUD - Rest Framework"""
 
-__version__ = "2.3.0"
+__version__ = "2.3.2"
 
 from .api import NinjaAIO
 

{django_ninja_aio_crud-2.3.0 → django_ninja_aio_crud-2.3.2}/ninja_aio/renders.py

@@ -6,6 +6,7 @@ import orjson
 from django.http import HttpRequest
 from django.conf import settings
 from ninja.renderers import BaseRenderer
+from pydantic import AnyUrl
 
 
 class ORJSONRenderer(BaseRenderer):
@@ -38,7 +39,7 @@ class ORJSONRenderer(BaseRenderer):
     def transform(cls, value):
         if isinstance(value, bytes):
             return base64.b64encode(value).decode()
-        if isinstance(value, (IPv4Address, IPv6Address)):
+        if isinstance(value, (IPv4Address, IPv6Address, AnyUrl)):
             return str(value)
         if isinstance(value, dict):
             return {k: cls.transform(v) for k, v in value.items()}

{django_ninja_aio_crud-2.3.0 → django_ninja_aio_crud-2.3.2}/pyproject.toml

@@ -28,9 +28,9 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP",
 ]
 
-requires = ["django-ninja >=1.3.0, <=1.5.1", "joserfc >=1.0.0, <= 1.4.1", "orjson >= 3.10.7, <= 3.11.5"]
+requires = ["django-ninja >=1.3.0, <1.6", "joserfc >=1.0.0, <= 1.4.1", "orjson >= 3.10.7, <= 3.11.5"]
 description-file = "README.md"
-requires-python = ">=3.10, <=3.14"
+requires-python = ">=3.10, <3.15"
 
 [tool.flit.metadata.requires-extra]
 test = [

django_ninja_aio_crud-2.3.0/examples/ex_1/models.py

@@ -1,35 +0,0 @@
-# Base usage example with a User model without any relation.
-
-from django.db import models
-from ninja_aio.models import ModelSerializer
-
-
-class User(ModelSerializer):
-    username = models.CharField(max_length=150, unique=True)
-    email = models.EmailField(unique=True)
-    first_name = models.CharField(max_length=30, blank=True)
-    last_name = models.CharField(max_length=30, blank=True)
-
-    @property
-    def full_name(self):
-        return f"{self.first_name} {self.last_name}"
-
-    class ReadSerializer:
-        fields = ["id", "username", "email"]
-        customs = [
-            ("full_name", str, ""),
-        ]
-
-    class CreateSerializer:
-        fields = ["username", "email"]
-        optionals = [("first_name", str), ("last_name", str)]
-
-    class UpdateSerializer:
-        optionals = [
-            ("email", str),
-            ("first_name", str),
-            ("last_name", str),
-        ]
-
-    def __str__(self):
-        return self.username

django_ninja_aio_crud-2.3.0/examples/ex_1/urls.py

@@ -1,11 +0,0 @@
-# Basic urls configuration for the example app
-
-from django.contrib import admin
-from django.urls import path
-
-from examples.ex_1.views import api
-
-urlpatterns = [
-    path("admin/", admin.site.urls),
-    path("api/v1/", api.urls),
-]

django_ninja_aio_crud-2.3.0/examples/ex_1/views.py

@@ -1,16 +0,0 @@
-# base example of a ViewSet using NinjaAIO and APIViewSet without any relation and auth.
-
-from ninja_aio import NinjaAIO
-from ninja_aio.views import APIViewSet
-
-from examples.ex_1.models import User
-
-api = NinjaAIO()
-
-
-class UserViewSet(APIViewSet):
-    model = User
-    api = api
-
-
-UserViewSet().add_views_to_route()

django_ninja_aio_crud-2.3.0/examples/ex_2/auth.py

@@ -1,33 +0,0 @@
-# Base usage example of a JWT authentication setup with NinjaAIO.
-
-from ninja_aio.auth import AsyncJwtBearer
-from ninja_aio.models import ModelUtil
-from django.conf import settings
-from joserfc import jwk
-
-from examples.ex_2.models import Customer
-
-
-PUBLIC_KEY: jwk.RSAKey = settings.JWT_PUBLIC_KEY
-ESSENTIAL_CLAIM = {"essential": True}
-MANDATORY_CLAIMS = {
-    "iat": ESSENTIAL_CLAIM,
-    "exp": ESSENTIAL_CLAIM,
-    "nbf": ESSENTIAL_CLAIM,
-    "aud": ESSENTIAL_CLAIM,
-    "sub": ESSENTIAL_CLAIM,
-}
-
-
-class JwtAuth(AsyncJwtBearer):
-    jwt_public = PUBLIC_KEY
-    claims = MANDATORY_CLAIMS
-
-    async def auth_handler(self, request):
-        try:
-            request.user = await ModelUtil(Customer).get_object(
-                request, self.dcd.claims.get("sub", ""), with_qs_request=False
-            )
-        except Customer.DoesNotExist:
-            return False
-        return True

django_ninja_aio_crud-2.3.0/examples/ex_2/models.py

@@ -1,62 +0,0 @@
-# Base usage example with a User model with Customer ForeignKey.
-
-from django.db import models
-from ninja_aio.models import ModelSerializer
-
-
-class Customer(ModelSerializer):
-    name = models.CharField(max_length=255)
-    email = models.EmailField(unique=True)
-
-    users: models.QuerySet["User"]
-
-    class ReadSerializer:
-        # Note: 'users' field will represent related User instances as list of their RelatedSerializer data
-        # This is automatically handled by NinjaAIO's ModelSerializer
-        fields = ["id", "name", "email", "users"]
-
-    class CreateSerializer:
-        fields = ["name", "email"]
-
-    class UpdateSerializer:
-        optionals = [
-            ("name", str),
-            ("email", str),
-        ]
-
-    def __str__(self):
-        return self.name
-
-
-class User(ModelSerializer):
-    username = models.CharField(max_length=150, unique=True)
-    email = models.EmailField(unique=True)
-    first_name = models.CharField(max_length=30, blank=True)
-    last_name = models.CharField(max_length=30, blank=True)
-    customer = models.ForeignKey(
-        Customer, on_delete=models.CASCADE, related_name="users"
-    )
-
-    @property
-    def full_name(self):
-        return f"{self.first_name} {self.last_name}"
-
-    class ReadSerializer:
-        fields = ["id", "username", "email", "customer"]
-        customs = [
-            ("full_name", str, ""),
-        ]
-
-    class CreateSerializer:
-        fields = ["username", "email", "customer"]
-        optionals = [("first_name", str), ("last_name", str)]
-
-    class UpdateSerializer:
-        optionals = [
-            ("email", str),
-            ("first_name", str),
-            ("last_name", str),
-        ]
-
-    def __str__(self):
-        return self.username

django_ninja_aio_crud-2.3.0/examples/ex_2/urls.py

@@ -1,11 +0,0 @@
-# Basic urls configuration for the example app
-
-from django.contrib import admin
-from django.urls import path
-
-from examples.ex_2.views import api
-
-urlpatterns = [
-    path("admin/", admin.site.urls),
-    path("api/v1/", api.urls),
-]

django_ninja_aio_crud-2.3.0/examples/ex_2/views.py

@@ -1,26 +0,0 @@
-# base example of a ViewSet using NinjaAIO and APIViewSet without any relation and auth.
-
-from ninja_aio import NinjaAIO
-from ninja_aio.views import APIViewSet
-
-from examples.ex_2 import models
-from examples.ex_2.auth import JwtAuth
-
-api = NinjaAIO()
-
-
-class BaseAPIViewSet(APIViewSet):
-    api = api
-    auth = [JwtAuth()]
-
-
-class CustomerViewSet(BaseAPIViewSet):
-    model = models.Customer
-
-
-class UserViewSet(BaseAPIViewSet):
-    model = models.User
-
-
-CustomerViewSet().add_views_to_route()
-UserViewSet().add_views_to_route()