djresttoolkit 1.2.0__tar.gz → 1.2.1__tar.gz

{djresttoolkit-1.2.0 → djresttoolkit-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 1.2.0
+Version: 1.2.1
 Summary: A collection of Django and DRF utilities to simplify API development.
 Project-URL: Homepage, https://github.com/shaileshpandit141/djresttoolkit
 Project-URL: Documentation, https://shaileshpandit141.github.io/djresttoolkit
@@ -970,7 +970,7 @@ from djresttoolkit.pagination import PaginatedDataBuilder
 ```python
 builder = PaginatedDataBuilder(
     request=request,
-    serializer_class=MySerializer,
+    serializer_class=BookSerializer,
     queryset=MyModel.objects.all()
 )
 ```
@@ -979,7 +979,7 @@ builder = PaginatedDataBuilder(
 - `serializer_class: type[BaseSerializer]`:- DRF serializer class for the model.
 - `queryset: QuerySet`:- Django queryset to paginate.
 
-### Paginated Data Builder Methods
+### Paginated Data Builder Methods and Property
 
 - `get_paginated_data() -> dict[str, Any]`
 
@@ -987,6 +987,10 @@ builder = PaginatedDataBuilder(
   - Serializes the paginated results.
   - Returns a dictionary with `"page"` and `"results"`.
   - Raises `NotFound` if no page data is found.
+  
+- `paginated_data -> dict[str, Any]`
+
+  - Call `paginated_data` property that internaly call `get_paginated_data()` method
 
 ### Example Response of Paginated Data Builder
 
@@ -1001,8 +1005,8 @@ builder = PaginatedDataBuilder(
     "previous": "http://api.example.com/items/?page=1&page-size=20"
   },
   "results": [
-    { "id": 21, "name": "Item 21" },
-    { "id": 22, "name": "Item 22" }
+    { "id": 21, "title": "Title 21" },
+    { "id": 22, "title": "Title 22" }
   ]
 }
 ```

{djresttoolkit-1.2.0 → djresttoolkit-1.2.1}/README.md

@@ -914,7 +914,7 @@ from djresttoolkit.pagination import PaginatedDataBuilder
 ```python
 builder = PaginatedDataBuilder(
     request=request,
-    serializer_class=MySerializer,
+    serializer_class=BookSerializer,
     queryset=MyModel.objects.all()
 )
 ```
@@ -923,7 +923,7 @@ builder = PaginatedDataBuilder(
 - `serializer_class: type[BaseSerializer]`:- DRF serializer class for the model.
 - `queryset: QuerySet`:- Django queryset to paginate.
 
-### Paginated Data Builder Methods
+### Paginated Data Builder Methods and Property
 
 - `get_paginated_data() -> dict[str, Any]`
 
@@ -931,6 +931,10 @@ builder = PaginatedDataBuilder(
   - Serializes the paginated results.
   - Returns a dictionary with `"page"` and `"results"`.
   - Raises `NotFound` if no page data is found.
+  
+- `paginated_data -> dict[str, Any]`
+
+  - Call `paginated_data` property that internaly call `get_paginated_data()` method
 
 ### Example Response of Paginated Data Builder
 
@@ -945,8 +949,8 @@ builder = PaginatedDataBuilder(
     "previous": "http://api.example.com/items/?page=1&page-size=20"
   },
   "results": [
-    { "id": 21, "name": "Item 21" },
-    { "id": 22, "name": "Item 22" }
+    { "id": 21, "title": "Title 21" },
+    { "id": 22, "title": "Title 22" }
   ]
 }
 ```

{djresttoolkit-1.2.0 → djresttoolkit-1.2.1}/demo/apps/todos/views.py

@@ -19,7 +19,7 @@ class TodoListView(APIView):
             serializer_class=TodoSerializer,
             queryset=Todo.objects.all(),
         )
-        return Response(data=pagination.get_paginated_data())
+        return Response(data=pagination.paginated_data)
 
     def post(self, request: Request) -> Response:
         serializer = TodoSerializer(

{djresttoolkit-1.2.0 → djresttoolkit-1.2.1}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "1.2.0"
+version = "1.2.1"
 description = "A collection of Django and DRF utilities to simplify API development."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }

{djresttoolkit-1.2.0 → djresttoolkit-1.2.1}/src/djresttoolkit/pagination/_paginated_data_builder.py

@@ -65,3 +65,7 @@ class PaginatedDataBuilder[T: Model]:
 
         logger.debug(f"Pagination result: {paginated_data}")
         return paginated_data
+
+    @property
+    def paginated_data(self) -> dict[str, Any]:
+        return self.get_paginated_data()