django-ninja-aio-crud 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

{django_ninja_aio_crud-0.2.0.dist-info → django_ninja_aio_crud-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-ninja-aio-crud
-Version: 0.2.0
+Version: 0.2.1
 Summary: Django Ninja AIO CRUD - Rest Framework 
 Author: Giuseppe Casillo
 Requires-Python: >=3.10
@@ -130,20 +130,21 @@ class Foo(ModelSerializer):
 
 - 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.
+- View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAIO class. NinjaAIO class uses built-in parser and renderer which use orjson for data serialization.
 
 ```Python
 # views.py
-from ninja import NinjAPI
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):
@@ -158,14 +159,15 @@ FooAPI().add_views_to_route()
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class ExampleSchemaOut(Schema):
@@ -196,12 +198,13 @@ FooAPI().add_views_to_route()
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIView
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class ExampleSchemaOut(Schema):
@@ -228,10 +231,7 @@ 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.
+- You can also set ForeignKey, OneToOne and ManyToMany relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
 
 - Define models:
 
@@ -270,14 +270,14 @@ class Foo(ModelSerializer):
 
 ```Python
 # views.py
-from ninja import NinjAPI
+from ninja_aio import NinjaAIO
 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())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):
@@ -336,14 +336,15 @@ class CustomJWTBearer(AsyncJWTBearer):
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet, APIView
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):

{django_ninja_aio_crud-0.2.0.dist-info → django_ninja_aio_crud-0.2.1.dist-info}/RECORD

@@ -1,4 +1,5 @@
-ninja_aio/__init__.py,sha256=jH3E7Jd2rKwk2oPVFUmf7KjKwvfN4qijMsg7QdGJ9SM,70
+ninja_aio/__init__.py,sha256=wVH_cPllWb0Bdyr7atTEbTJxhDdYsDjbn1CVCeB_e60,120
+ninja_aio/api.py,sha256=qEnCOvviJGfg28N9R2XWzykLGOFpJ0JMqe3rm4AYDkM,1564
 ninja_aio/auth.py,sha256=hGgiblvffpHmmakjaxdNT3G0tq39-Bvc5oLNqjn4qd8,1300
 ninja_aio/exceptions.py,sha256=PPNr1CdC7M7Kx1MtiBGuR4hATYQqEuvxCRU6uSG7rgM,543
 ninja_aio/models.py,sha256=xUZ0998bYkWumwZgnVC7P-CLdbfTzFflmJVbusU2UMY,11276
@@ -6,6 +7,6 @@ ninja_aio/parsers.py,sha256=e_4lGCPV7zs-HTqtdJTc8yQD2KPAn9njbL8nF_Mmgkc,153
 ninja_aio/renders.py,sha256=wLQisbIsMJlGYJMO4Ud-qiaVCvz4yxiZ4mYommixAeQ,1453
 ninja_aio/schemas.py,sha256=EgRkfhnzZqwGvdBmqlZixMtMcoD1ZxV_qzJ3fmaAy20,113
 ninja_aio/views.py,sha256=ejn6adCe91YKo0-0bRePbuARHkz8YWMmP54WxQLLqxY,6322
-django_ninja_aio_crud-0.2.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-django_ninja_aio_crud-0.2.0.dist-info/METADATA,sha256=HPVwB-vF9GmJALzGam7lD_V4WJHMRLswMouJl6-j1w4,10440
-django_ninja_aio_crud-0.2.0.dist-info/RECORD,,
+django_ninja_aio_crud-0.2.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+django_ninja_aio_crud-0.2.1.dist-info/METADATA,sha256=cB1AOW4xZ0DLUpgMAF6AMJVYP48aKy3xQZowVsFWP0g,10135
+django_ninja_aio_crud-0.2.1.dist-info/RECORD,,

ninja_aio/__init__.py

@@ -1,3 +1,7 @@
 """ Django Ninja AIO CRUD - Rest Framework """
 
-__version__ = "0.2.0"
+__version__ = "0.2.1"
+
+from .api import NinjaAIO
+
+__all__ = ["NinjaAIO"]

ninja_aio/api.py

@@ -0,0 +1,48 @@
+from typing import Any, Sequence
+
+from ninja.router import Router
+from ninja.throttling import BaseThrottle
+from ninja import NinjaAPI
+from ninja.openapi.docs import DocsBase, Swagger
+from ninja.constants import NOT_SET, NOT_SET_TYPE
+
+from ninja_aio.parsers import ORJSONParser
+from ninja_aio.renders import ORJSONRenderer
+
+
+class NinjaAIO(NinjaAPI):
+    def __init__(
+        self,
+        title: str = "NinjaAPI",
+        version: str = "1.0.0",
+        description: str = "",
+        openapi_url: str | None = "/openapi.json",
+        docs: DocsBase = Swagger(),
+        docs_url: str | None = "/docs",
+        docs_decorator = None,
+        servers: list[dict[str, Any]] | None = None,
+        urls_namespace: str | None = None,
+        csrf: bool = False,
+        auth: Sequence[Any]| NOT_SET_TYPE = NOT_SET,
+        throttle: BaseThrottle | list[BaseThrottle] | NOT_SET_TYPE = NOT_SET,
+        default_router: Router | None = None,
+        openapi_extra: dict[str, Any] | None = None
+    ):
+        super().__init__(
+            title=title,
+            version=version,
+            description=description,
+            openapi_url=openapi_url,
+            docs=docs,
+            docs_url=docs_url,
+            docs_decorator=docs_decorator,
+            servers=servers,
+            urls_namespace=urls_namespace,
+            csrf=csrf,
+            auth=auth,
+            throttle=throttle,
+            default_router=default_router,
+            openapi_extra=openapi_extra,
+            renderer=ORJSONRenderer(),
+            parser=ORJSONParser(),
+        )