django-ninja-aio-crud 2.17.0__py3-none-any.whl → 2.18.1__py3-none-any.whl

django_ninja_aio_crud-2.17.0.dist-info/METADATA

@@ -1,379 +0,0 @@
-Metadata-Version: 2.4
-Name: django-ninja-aio-crud
-Version: 2.17.0
-Summary: Django Ninja AIO CRUD - Rest Framework
-Author: Giuseppe Casillo
-Requires-Python: >=3.10, <3.15
-Description-Content-Type: text/markdown
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Internet
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Software Development
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Framework :: Django
-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.6
-Requires-Dist: joserfc >=1.0.0, <= 1.4.1
-Requires-Dist: orjson >= 3.10.7, <= 3.11.5
-Requires-Dist: coverage ; extra == "test"
-Project-URL: Documentation, https://django-ninja-aio.com
-Project-URL: Repository, https://github.com/caspel26/django-ninja-aio-crud
-Provides-Extra: test
-
-# 🥷 django-ninja-aio-crud
-
-![Tests](https://github.com/caspel26/django-ninja-aio-crud/actions/workflows/coverage.yml/badge.svg)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=caspel26_django-ninja-aio-crud&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=caspel26_django-ninja-aio-crud)
-[![codecov](https://codecov.io/gh/caspel26/django-ninja-aio-crud/graph/badge.svg?token=DZ5WDT3S20)](https://codecov.io/gh/caspel26/django-ninja-aio-crud/)
-[![PyPI - Version](https://img.shields.io/pypi/v/django-ninja-aio-crud?color=g&logo=pypi&logoColor=white)](https://pypi.org/project/django-ninja-aio-crud/)
-[![PyPI - License](https://img.shields.io/pypi/l/django-ninja-aio-crud)](LICENSE)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-
-> Lightweight async CRUD layer on top of **[Django Ninja](https://django-ninja.dev/)** with automatic schema generation, filtering, pagination, auth & Many‑to‑Many management.
-
----
-
-## ✨ Features
-
-- Serializer (Meta-driven) first-class: dynamic schemas for existing Django models without inheriting ModelSerializer
-- Async CRUD ViewSets (create, list, retrieve, update, delete)
-- Automatic Pydantic schemas from `ModelSerializer` (read/create/update)
-- Dynamic query params (runtime schema via `pydantic.create_model`)
-- Per-method authentication (`auth`, `get_auth`, `post_auth`, etc.)
-- Async pagination (customizable)
-- M2M relation endpoints via `M2MRelationSchema` (add/remove/get + filters)
-- Reverse relation serialization
-- Hook methods (`query_params_handler`, `<related>_query_params_handler`, `custom_actions`, lifecycle hooks)
-- ORJSON renderer through `NinjaAIO`
-- Clean, minimal integration
-
----
-
-## 🚀 Quick Start (Serializer)
-
-If you already have Django models, start with the Meta-driven Serializer for instant CRUD without changing model base classes.
-
-```python
-from ninja_aio.models import serializers
-from ninja_aio.views import APIViewSet
-from ninja_aio import NinjaAIO
-from . import models
-
-class BookSerializer(serializers.Serializer):
-    class Meta:
-        model = models.Book
-        schema_in = serializers.SchemaModelConfig(fields=["title", "published"])
-        schema_out = serializers.SchemaModelConfig(fields=["id", "title", "published"])
-        schema_update = serializers.SchemaModelConfig(optionals=[("title", str), ("published", bool)])
-
-api = NinjaAIO()
-
-@api.viewset(models.Book)
-class BookViewSet(APIViewSet):
-    serializer_class = BookSerializer
-```
-
-Visit `/docs` → CRUD endpoints ready.
-
----
-
-## 🚀 Quick Start (ModelSerializer)
-
-models.py
-
-```python
-from django.db import models
-from ninja_aio.models import ModelSerializer
-
-class Book(ModelSerializer):
-    title = models.CharField(max_length=120)
-    published = models.BooleanField(default=True)
-
-    class ReadSerializer:
-        fields = ["id", "title", "published"]
-
-    class CreateSerializer:
-        fields = ["title", "published"]
-
-    class UpdateSerializer:
-        optionals = [("title", str), ("published", bool)]
-```
-
-views.py
-
-```python
-from ninja_aio import NinjaAIO
-from ninja_aio.views import APIViewSet
-from .models import Book
-
-api = NinjaAIO()
-
-@api.viewset(Book)
-class BookViewSet(APIViewSet):
-    pass
-
-```
-
-Visit `/docs` → CRUD endpoints ready.
-
----
-
-## 🔄 Query Filtering
-
-```python
-@api.viewset(Book)
-class BookViewSet(APIViewSet):
-    query_params = {"published": (bool, None), "title": (str, None)}
-
-    async def query_params_handler(self, queryset, filters):
-        if filters.get("published") is not None:
-            queryset = queryset.filter(published=filters["published"])
-        if filters.get("title"):
-            queryset = queryset.filter(title__icontains=filters["title"])
-        return queryset
-```
-
-Request:
-
-```
-GET /book/?published=true&title=python
-```
-
----
-
-## 🤝 Many-to-Many Example (with filters)
-
-```python
-from ninja_aio.schemas import M2MRelationSchema
-
-class Tag(ModelSerializer):
-    name = models.CharField(max_length=50)
-    class ReadSerializer:
-        fields = ["id", "name"]
-
-class Article(ModelSerializer):
-    title = models.CharField(max_length=120)
-    tags = models.ManyToManyField(Tag, related_name="articles")
-
-    class ReadSerializer:
-        fields = ["id", "title", "tags"]
-
-@api.viewset(Article)
-class ArticleViewSet(APIViewSet):
-    m2m_relations = [
-        M2MRelationSchema(
-            model=Tag,
-            related_name="tags",
-            filters={"name": (str, "")}
-        )
-    ]
-
-    async def tags_query_params_handler(self, queryset, filters):
-        n = filters.get("name")
-        if n:
-            queryset = queryset.filter(name__icontains=n)
-        return queryset
-
-```
-
-Endpoints:
-
-- `GET /article/{pk}/tag?name=dev`
-- `POST /article/{pk}/tag/` body: `{"add":[1,2],"remove":[3]}`
-
----
-
-## 🔐 Authentication (JWT example)
-
-```python
-from ninja_aio.auth import AsyncJwtBearer
-from joserfc import jwk
-from .models import Book
-
-PUBLIC_KEY = "-----BEGIN PUBLIC KEY----- ..."
-
-class JWTAuth(AsyncJwtBearer):
-    jwt_public = jwk.RSAKey.import_key(PUBLIC_KEY)
-    jwt_alg = "RS256"
-    claims = {"sub": {"essential": True}}
-
-    async def auth_handler(self, request):
-        book_id = self.dcd.claims.get("sub")
-        return await Book.objects.aget(id=book_id)
-
-@api.viewset(Book)
-class SecureBookViewSet(APIViewSet):
-    auth = [JWTAuth()]
-    get_auth = None  # list/retrieve public
-```
-
----
-
-## 📑 Lifecycle Hooks (ModelSerializer)
-
-Available on every save/delete:
-
-- `on_create_before_save`
-- `on_create_after_save`
-- `before_save`
-- `after_save`
-- `on_delete`
-- `custom_actions(payload)` (create/update custom field logic)
-- `post_create()` (after create commit)
-
----
-
-## 🧩 Adding Custom Endpoints
-
-```python
-from ninja_aio.decorators import api_get
-
-@api.viewset(Book)
-class BookViewSet(APIViewSet):
-    @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):
-            total = await Book.objects.acount()
-            return {"total": total}
-```
-
----
-
-## 📄 Pagination
-
-Default: `PageNumberPagination`. Override:
-
-```python
-from ninja.pagination import PageNumberPagination
-
-class LargePagination(PageNumberPagination):
-    page_size = 50
-    max_page_size = 200
-
-@api.viewset(Book)
-class BookViewSet(APIViewSet):
-    pagination_class = LargePagination
-```
-
----
-
-## Meta-driven Serializer (for vanilla Django models)
-
-Moved above as the primary quick start.
-
----
-
-## 🛠 Project Structure & Docs
-
-Documentation (MkDocs + Material):
-
-```
-docs/
-  getting_started/
-  tutorial/
-  api/
-    views/
-    models/
-    authentication.md
-    pagination.md
-```
-
-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`
-- 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()
-```
-
----
-
-## 🚫 Disable Operations
-
-```python
-@api.viewset(Book)
-class ReadOnlyBookViewSet(APIViewSet):
-    disable = ["update", "delete"]
-```
-
----
-
-## 📌 Performance Tips
-
-- Use `queryset_request` classmethod to prefetch
-- Index frequently filtered fields
-- Keep pagination enabled
-- Limit slices (`queryset = queryset[:1000]`) for heavy searches
-
----
-
-## 🤲 Contributing
-
-1. Fork
-2. Create branch
-3. Add tests
-4. Run lint (`ruff check .`)
-5. Open PR
-
----
-
-## ⭐ Support
-
-Star the repo or donate:
-
-- [Buy me a coffee](https://buymeacoffee.com/caspel26)
-
----
-
-## 📜 License
-
-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 |
-| Example | https://github.com/caspel26/ninja-aio-blog-example       |
-
----
-