django-ninja-aio-crud 0.1.2__tar.gz → 0.1.3__tar.gz

{django_ninja_aio_crud-0.1.2 → django_ninja_aio_crud-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-ninja-aio-crud
-Version: 0.1.2
+Version: 0.1.3
 Summary: Django Ninja AIO CRUD - Rest Framework 
 Author: Giuseppe Casillo
 Requires-Python: >=3.10
@@ -34,24 +34,32 @@ Project-URL: Repository, https://github.com/caspel26/django-ninja-aio-crud
 ## 📝 Instructions
 
 ### 📚 Prerequisites
+
 - Install Python from the [official website](https://www.python.org/) (latest version) and ensure it is added to the system Path and environment variables.
 
 ### 💻 Setup your environment
+
 - Create a virtual environment
 ```bash
 python -m venv .venv
 ```
+
 ### ✅ Activate it
+
 - If you are from linux activate it with
+
 ```bash
 . .venv/bin/activate
 ```
+
 - If you are from windows activate it with
+
 ```bash
 . .venv/Scripts/activate
 ```
 
 ### 📥 Install package
+
 ```bash
 pip install django-ninja-aio-crud
 ```
@@ -63,14 +71,17 @@ pip install django-ninja-aio-crud
 > and why not ... [Buy me a coffee](https://buymeacoffee.com/caspel26)
 
 ### ModelSerializer
+
 - You can serialize your models using ModelSerializer and made them inherit from it. In your models.py import ModelSerializer
 ```Python
+# models.py
+from django.db import models
 from ninja_aio.models import ModelSerializer
 
 
 class Foo(ModelSerializer):
-  name = mdoels.CharField()
-  bar = models.CharField()
+  name = models.CharField(max_length=30)
+  bar = models.CharField(max_length=30)
 
   class ReadSerializer:
     fields = ["id", "name", "bar"]
@@ -81,14 +92,18 @@ class Foo(ModelSerializer):
   class UpdateSerializer:
     fields = ["name", "bar"]
 ```
+
 - ReadSerializer, CreateSerializer, UpdateSerializer are used to define which fields would be included in runtime schemas creation. You can also specify custom fields and handle their function by overriding custom_actions ModelSerializer's method(custom fields are only available for Create and Update serializers).
+
 ```Python
+# models.py
+from django.db import models
 from ninja_aio.models import ModelSerializer
 
 
 class Foo(ModelSerializer):
-  name = mdoels.CharField()
-  bar = models.CharField()
+  name = models.CharField(max_length=30)
+  bar = models.CharField(max_length=30)
   active = models.BooleanField(default=False)
 
   class ReadSerializer:
@@ -112,12 +127,15 @@ class Foo(ModelSerializer):
       self.active = True
       await self.asave()
 ```
-- post create method is a custom method that comes out to handle actions which will be excuted after that the object is created. It can be used, indeed, for example to handle custom fields' actions.
 
+- post create method is a custom method that comes out to handle actions which will be excuted after that the object is created. It can be used, indeed, for example to handle custom fields' actions.
 
 ### APIViewSet
+
 - View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAPI class. As Parser and Render of the API you must use ninja_aio built-in classes which will serialize data using orjson.
+
 ```Python
+# views.py
 from ninja import NinjAPI
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
@@ -135,8 +153,11 @@ class FooAPI(APIViewSet):
   
 FooAPI().add_views_to_route()
 ```
+
 - and that's it, your model CRUD will be automatically created. You can also add custom views to CRUD overriding the built-in method "views".
+
 ```Python
+# views.py
 from ninja import NinjAPI, Schema
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
@@ -161,7 +182,7 @@ class FooAPI(APIViewSet):
   api = api
 
   def views(self):
-    @self.router.post("numbers-sum/", response={200: ExampleSchemaOut)
+    @self.router.post("numbers-sum/", response={200: ExampleSchemaOut})
     async def sum(request: HttpRequest, data: ExampleSchemaIn):
         return 200, {sum: data.n1 + data.n2}
 
@@ -170,8 +191,11 @@ FooAPI().add_views_to_route()
 ```
 
 ### APIView
+
 - View class to code generic views class based. In your views.py import APIView class.
+
 ```Python
+# views.py
 from ninja import NinjAPI, Schema
 from ninja_aio.views import APIView
 from ninja_aio.parsers import ORJSONParser
@@ -195,7 +219,7 @@ class SumView(APIView):
   router_tag = "Sum"
 
   def views(self):
-    @self.router.post(self.api_router_path, response={200: ExampleSchemaOut)
+    @self.router.post("/", response={200: ExampleSchemaOut})
     async def sum(request: HttpRequest, data: ExampleSchemaIn):
         return 200, {sum: data.n1 + data.n2}
 
@@ -203,9 +227,91 @@ class SumView(APIView):
 SumView().add_views_to_route()
 ```
 
+### Relations
+- You can also set ForeignKey and OneToOne relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
+
+> [!WARNING]
+> Only ForeignKey and OneToOne relations are supported for serialization, ManyToMany relations are not supported yet.
+
+- Define models:
+
+```Python
+# models.py
+class Bar(ModelSerializer):
+    name = models.CharField(max_length=30)
+    description = models.TextField(max_length=30)
+
+    # ReadSerializer with reverse OneToMany relation (foos)
+    class ReadSerializer:
+        fields = ["id", "name", "description", "foos"]
+
+    class CreateSerializer:
+        fields = ["name", "description"]
+
+    class UpdateSerializer:
+        fields = ["name", "description"]
+
+
+class Foo(ModelSerializer):
+    name = models.CharField(max_length=30)
+    bar = models.ForeignKey(Bar, on_delete=models.CASCADE, related_name="foos")
+
+    class ReadSerializer:
+        fields = ["id", "name", "bar"]
+
+    class CreateSerializer:
+        fields = ["name", "bar"]
+
+    class UpdateSerializer:
+        fields = ["name"]
+```
+
+- Define views:
+
+```Python
+# views.py
+from ninja import NinjAPI
+from ninja_aio.views import APIViewSet
+from ninja_aio.parsers import ORJSONParser
+from ninja_aio.renders import ORJSONRender
+
+from .models import Foo, Bar
+
+api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+
+
+class FooAPI(APIViewSet):
+  model = Foo
+  api = api
+
+
+class BarAPI(APIViewSet):
+  model = Bar
+  api = api
+
+
+FooAPI().add_views_to_route()
+BarAPI().add_views_to_route()
+```
+
+- Now run your server and go to /docs url:
+
+### Docs
+
+- Foo Schemas
+
+![Swagger UI](ninja_aio/docs/images/foo-swagger.png)
+
+- Bar Schemas with reverse relation
+
+![Swagger UI](ninja_aio/docs/images/bar-swagger.png)
+
 ## 🔒 Authentication
+
 ### Jwt
+
 - AsyncJWTBearer built-in class is an authenticator class which use joserfc module. It cames out with authenticate method which validate given claims. Override auth handler method to write your own authentication method. Default algorithms used is RS256. a jwt Token istance is set as class atribute so you can use it by self.dcd.  
+
 ```Python
 from ninja_aio.auth import AsyncJWTBearer
 from django.conf import settings
@@ -225,8 +331,11 @@ class CustomJWTBearer(AsyncJWTBearer):
         return None
       return request.user
 ```
+
 - Then add it to views.
+
 ```Python
+# views.py
 from ninja import NinjAPI, Schema
 from ninja_aio.views import APIViewSet, APIView
 from ninja_aio.parsers import ORJSONParser
@@ -259,7 +368,7 @@ class SumView(APIView):
   auths = CustomJWTBearer()
 
   def views(self):
-    @self.router.post(self.api_router_path, response={200: ExampleSchemaOut}, auth=self.auths)
+    @self.router.post("/", response={200: ExampleSchemaOut}, auth=self.auths)
     async def sum(request: HttpRequest, data: ExampleSchemaIn):
         return 200, {sum: data.n1 + data.n2}
 
@@ -268,6 +377,20 @@ FooAPI().add_views_to_route()
 SumView().add_views_to_route()
 ```
 
+## 📝 Pagination
+
+- By default APIViewSet list view uses Django Ninja built-in AsyncPagination class "PageNumberPagination". You can customize and assign it to APIViewSet class. To make your custom pagination consult **<a href="https://django-ninja.dev/guides/response/pagination/#async-pagination">Django Ninja pagination documentation</a>**.
+
+```Python
+# views.py
+
+class FooAPI(APIViewSet):
+  model = Foo
+  api = api
+  pagination_class = CustomPaginationClass
+
+```
+
 ## 📌 Notes
 - Feel free to contribute and improve the program. 🛠️
 

{django_ninja_aio_crud-0.1.2 → django_ninja_aio_crud-0.1.3}/README.md

@@ -5,24 +5,32 @@
 ## 📝 Instructions
 
 ### 📚 Prerequisites
+
 - Install Python from the [official website](https://www.python.org/) (latest version) and ensure it is added to the system Path and environment variables.
 
 ### 💻 Setup your environment
+
 - Create a virtual environment
 ```bash
 python -m venv .venv
 ```
+
 ### ✅ Activate it
+
 - If you are from linux activate it with
+
 ```bash
 . .venv/bin/activate
 ```
+
 - If you are from windows activate it with
+
 ```bash
 . .venv/Scripts/activate
 ```
 
 ### 📥 Install package
+
 ```bash
 pip install django-ninja-aio-crud
 ```
@@ -34,14 +42,17 @@ pip install django-ninja-aio-crud
 > and why not ... [Buy me a coffee](https://buymeacoffee.com/caspel26)
 
 ### ModelSerializer
+
 - You can serialize your models using ModelSerializer and made them inherit from it. In your models.py import ModelSerializer
 ```Python
+# models.py
+from django.db import models
 from ninja_aio.models import ModelSerializer
 
 
 class Foo(ModelSerializer):
-  name = mdoels.CharField()
-  bar = models.CharField()
+  name = models.CharField(max_length=30)
+  bar = models.CharField(max_length=30)
 
   class ReadSerializer:
     fields = ["id", "name", "bar"]
@@ -52,14 +63,18 @@ class Foo(ModelSerializer):
   class UpdateSerializer:
     fields = ["name", "bar"]
 ```
+
 - ReadSerializer, CreateSerializer, UpdateSerializer are used to define which fields would be included in runtime schemas creation. You can also specify custom fields and handle their function by overriding custom_actions ModelSerializer's method(custom fields are only available for Create and Update serializers).
+
 ```Python
+# models.py
+from django.db import models
 from ninja_aio.models import ModelSerializer
 
 
 class Foo(ModelSerializer):
-  name = mdoels.CharField()
-  bar = models.CharField()
+  name = models.CharField(max_length=30)
+  bar = models.CharField(max_length=30)
   active = models.BooleanField(default=False)
 
   class ReadSerializer:
@@ -83,12 +98,15 @@ class Foo(ModelSerializer):
       self.active = True
       await self.asave()
 ```
-- post create method is a custom method that comes out to handle actions which will be excuted after that the object is created. It can be used, indeed, for example to handle custom fields' actions.
 
+- post create method is a custom method that comes out to handle actions which will be excuted after that the object is created. It can be used, indeed, for example to handle custom fields' actions.
 
 ### APIViewSet
+
 - View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAPI class. As Parser and Render of the API you must use ninja_aio built-in classes which will serialize data using orjson.
+
 ```Python
+# views.py
 from ninja import NinjAPI
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
@@ -106,8 +124,11 @@ class FooAPI(APIViewSet):
   
 FooAPI().add_views_to_route()
 ```
+
 - and that's it, your model CRUD will be automatically created. You can also add custom views to CRUD overriding the built-in method "views".
+
 ```Python
+# views.py
 from ninja import NinjAPI, Schema
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
@@ -132,7 +153,7 @@ class FooAPI(APIViewSet):
   api = api
 
   def views(self):
-    @self.router.post("numbers-sum/", response={200: ExampleSchemaOut)
+    @self.router.post("numbers-sum/", response={200: ExampleSchemaOut})
     async def sum(request: HttpRequest, data: ExampleSchemaIn):
         return 200, {sum: data.n1 + data.n2}
 
@@ -141,8 +162,11 @@ FooAPI().add_views_to_route()
 ```
 
 ### APIView
+
 - View class to code generic views class based. In your views.py import APIView class.
+
 ```Python
+# views.py
 from ninja import NinjAPI, Schema
 from ninja_aio.views import APIView
 from ninja_aio.parsers import ORJSONParser
@@ -166,7 +190,7 @@ class SumView(APIView):
   router_tag = "Sum"
 
   def views(self):
-    @self.router.post(self.api_router_path, response={200: ExampleSchemaOut)
+    @self.router.post("/", response={200: ExampleSchemaOut})
     async def sum(request: HttpRequest, data: ExampleSchemaIn):
         return 200, {sum: data.n1 + data.n2}
 
@@ -174,9 +198,91 @@ class SumView(APIView):
 SumView().add_views_to_route()
 ```
 
+### Relations
+- You can also set ForeignKey and OneToOne relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
+
+> [!WARNING]
+> Only ForeignKey and OneToOne relations are supported for serialization, ManyToMany relations are not supported yet.
+
+- Define models:
+
+```Python
+# models.py
+class Bar(ModelSerializer):
+    name = models.CharField(max_length=30)
+    description = models.TextField(max_length=30)
+
+    # ReadSerializer with reverse OneToMany relation (foos)
+    class ReadSerializer:
+        fields = ["id", "name", "description", "foos"]
+
+    class CreateSerializer:
+        fields = ["name", "description"]
+
+    class UpdateSerializer:
+        fields = ["name", "description"]
+
+
+class Foo(ModelSerializer):
+    name = models.CharField(max_length=30)
+    bar = models.ForeignKey(Bar, on_delete=models.CASCADE, related_name="foos")
+
+    class ReadSerializer:
+        fields = ["id", "name", "bar"]
+
+    class CreateSerializer:
+        fields = ["name", "bar"]
+
+    class UpdateSerializer:
+        fields = ["name"]
+```
+
+- Define views:
+
+```Python
+# views.py
+from ninja import NinjAPI
+from ninja_aio.views import APIViewSet
+from ninja_aio.parsers import ORJSONParser
+from ninja_aio.renders import ORJSONRender
+
+from .models import Foo, Bar
+
+api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+
+
+class FooAPI(APIViewSet):
+  model = Foo
+  api = api
+
+
+class BarAPI(APIViewSet):
+  model = Bar
+  api = api
+
+
+FooAPI().add_views_to_route()
+BarAPI().add_views_to_route()
+```
+
+- Now run your server and go to /docs url:
+
+### Docs
+
+- Foo Schemas
+
+![Swagger UI](ninja_aio/docs/images/foo-swagger.png)
+
+- Bar Schemas with reverse relation
+
+![Swagger UI](ninja_aio/docs/images/bar-swagger.png)
+
 ## 🔒 Authentication
+
 ### Jwt
+
 - AsyncJWTBearer built-in class is an authenticator class which use joserfc module. It cames out with authenticate method which validate given claims. Override auth handler method to write your own authentication method. Default algorithms used is RS256. a jwt Token istance is set as class atribute so you can use it by self.dcd.  
+
 ```Python
 from ninja_aio.auth import AsyncJWTBearer
 from django.conf import settings
@@ -196,8 +302,11 @@ class CustomJWTBearer(AsyncJWTBearer):
         return None
       return request.user
 ```
+
 - Then add it to views.
+
 ```Python
+# views.py
 from ninja import NinjAPI, Schema
 from ninja_aio.views import APIViewSet, APIView
 from ninja_aio.parsers import ORJSONParser
@@ -230,7 +339,7 @@ class SumView(APIView):
   auths = CustomJWTBearer()
 
   def views(self):
-    @self.router.post(self.api_router_path, response={200: ExampleSchemaOut}, auth=self.auths)
+    @self.router.post("/", response={200: ExampleSchemaOut}, auth=self.auths)
     async def sum(request: HttpRequest, data: ExampleSchemaIn):
         return 200, {sum: data.n1 + data.n2}
 
@@ -239,5 +348,19 @@ FooAPI().add_views_to_route()
 SumView().add_views_to_route()
 ```
 
+## 📝 Pagination
+
+- By default APIViewSet list view uses Django Ninja built-in AsyncPagination class "PageNumberPagination". You can customize and assign it to APIViewSet class. To make your custom pagination consult **<a href="https://django-ninja.dev/guides/response/pagination/#async-pagination">Django Ninja pagination documentation</a>**.
+
+```Python
+# views.py
+
+class FooAPI(APIViewSet):
+  model = Foo
+  api = api
+  pagination_class = CustomPaginationClass
+
+```
+
 ## 📌 Notes
 - Feel free to contribute and improve the program. 🛠️

{django_ninja_aio_crud-0.1.2 → django_ninja_aio_crud-0.1.3}/ninja_aio/__init__.py

@@ -1,3 +1,3 @@
 """ Django Ninja AIO CRUD - Rest Framework """
 
-__version__ = "0.1.2"
+__version__ = "0.1.3"

{django_ninja_aio_crud-0.1.2 → django_ninja_aio_crud-0.1.3}/ninja_aio/models.py

@@ -204,18 +204,6 @@ class ModelSerializer(models.Model):
             return None
         return customs
 
-    @classmethod
-    def get_optional_fields(cls, s_type: type[S_TYPES]) -> list[str] | None:
-        try:
-            match s_type:
-                case "create":
-                    optionals = cls.CreateSerializer.optionals
-                case "update":
-                    optionals = cls.UpdateSerializer.optionals
-        except AttributeError:
-            return None
-        return optionals
-
     @classmethod
     def generate_read_s(cls, depth: int = 1) -> Schema:
         fields, reverse_rels = cls.get_schema_out_data()
@@ -234,7 +222,6 @@ class ModelSerializer(models.Model):
             model=cls,
             name=f"{cls._meta.model_name}SchemaIn",
             fields=cls.CreateSerializer.fields,
-            optional_fields=cls.get_optional_fields("create"),
             custom_fields=cls.get_custom_fields("create"),
         )
 
@@ -244,7 +231,6 @@ class ModelSerializer(models.Model):
             model=cls,
             name=f"{cls._meta.model_name}SchemaPatch",
             fields=cls.UpdateSerializer.fields,
-            optional_fields=cls.get_optional_fields("update"),
             custom_fields=cls.get_custom_fields("update"),
         )
 

{django_ninja_aio_crud-0.1.2 → django_ninja_aio_crud-0.1.3}/ninja_aio/views.py

@@ -2,6 +2,7 @@ from typing import List
 
 from ninja import NinjaAPI, Router
 from ninja.constants import NOT_SET
+from ninja.pagination import paginate, AsyncPaginationBase, PageNumberPagination
 from django.http import HttpRequest
 
 from .models import ModelSerializer
@@ -67,6 +68,7 @@ class APIViewSet:
     model: ModelSerializer
     api: NinjaAPI
     auths: list | None = NOT_SET
+    pagination_class: type[AsyncPaginationBase] = PageNumberPagination
 
     def __init__(self) -> None:
         self.router = Router(tags=[self.model._meta.model_name.capitalize()])
@@ -97,6 +99,7 @@ class APIViewSet:
                 self.error_codes: GenericMessageSchema,
             },
         )
+        @paginate(self.pagination_class)
         async def list(request: HttpRequest):
             qs = await self.model.queryset_request(request)
             rels = self.model.get_reverse_relations()