django-api-versioning 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

django_api_versioning/decorators.py

@@ -20,10 +20,16 @@ def endpoint(
     - Ensures that no version lower than `API_MIN_VERSION` is registered.
     
     Args:
-        postfix (str): The endpoint suffix (e.g., "users" → "api/v1/users").
-        version (Optional[int]): The version of the API. Defaults to None (unversioned).
-        backward (bool): If True, registers routes for all versions from `API_MIN_VERSION` up to the current version, which is less than or equal to `API_MAX_VERSION`. Defaults to True.
-        app_name (Optional[str]): The app name to be prefixed to the route.
+        postfix (str): The endpoint suffix (e.g., "users" →
+                    "api/v1/users").
+        version (Optional[int]): The version of the API. Defaults
+                                to None (unversioned).
+        backward (bool): If True, registers routes for all versions
+                        from `API_MIN_VERSION` up to the current
+                        version, which is less than or equal to
+                        `API_MAX_VERSION`. Defaults to True.
+        app_name (Optional[str]): The app name to be prefixed to
+                                the route.
         view_name (Optional[str]): The custom view name for Django.
 
     Returns:

django_api_versioning/settings.py

@@ -2,7 +2,7 @@ import logging
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from dataclasses import dataclass
-from typing import Optional
+from typing import Optional, Any
 from .exceptions import VersionTypeError, VersionRangeError, VersioningError
 
 # Initialize logger
@@ -10,14 +10,14 @@ logger = logging.getLogger(__name__)
 
 @dataclass
 class APISettings:
-
+    
     API_BASE_PATH: str = "api/v{version}/"
     API_MAX_VERSION: int = 1
     API_MIN_VERSION: int = 1
     ROOT_URLCONF: str = 'django_api_versioning.urls'
 
     @staticmethod
-    def get_setting(name: str, default: Optional[any] = None) -> Optional[any]:
+    def get_setting(name: str, default: Optional[Any] = None) -> Any:
         """
         Reads the setting from Django settings and provides a default if not found.
         """
@@ -30,9 +30,7 @@ class APISettings:
         
         # Ensure that API_BASE_PATH ends with a "/"
         if not self.API_BASE_PATH.endswith("/"):
-            logger.warning(
-                "API_BASE_PATH should end with a '/'. Adding '/' automatically."
-            )
+            logger.warning("API_BASE_PATH should end with a '/'. Adding '/' automatically.")
             self.API_BASE_PATH += "/"
 
         # Validate version settings

{django_api_versioning-0.1.0.dist-info → django_api_versioning-0.1.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: django-api-versioning
-Version: 0.1.0
-Summary: A powerful and flexible library for managing API versioning in Django projects.
+Version: 0.1.1
+Summary: Django API versioning decorator provides a solution for managing multiple API versions within the Django framework, enabling versioning through URLs with backward compatibility and automatically registering routes.
 Home-page: https://github.com/mojtaba-arvin/django-api-versioning
 Author: Mojtaba Arvin
 Author-email: ArvinDevDay@gmail.com
@@ -31,7 +31,6 @@ Requires-Dist: pre-commit>=2.0.0; extra == "dev"
 Requires-Dist: twine>=4.0.0; extra == "dev"
 Requires-Dist: build>=0.8.0; extra == "dev"
 
-
 # Django API Versioning
 
 [![PyPI version](https://badge.fury.io/py/django-api-versioning.svg)](https://badge.fury.io/py/django-api-versioning)
@@ -39,7 +38,7 @@ Requires-Dist: build>=0.8.0; extra == "dev"
 [![codecov](https://codecov.io/gh/mojtaba-arvin/django-api-versioning/branch/main/graph/badge.svg)](https://codecov.io/gh/mojtaba-arvin/django-api-versioning)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**Django API Versioning** is a powerful and flexible library for managing API versioning in Django projects. It allows you to easily define and manage different versions of your API endpoints using decorators, ensuring backward compatibility and clean code organization.
+**Django API Versioning** is a powerful and flexible library for managing [API versioning in Django](https://github.com/mojtaba-arvin/django-api-versioning) projects. It allows you to easily define and manage different versions of your API endpoints using decorators, ensuring backward compatibility and clean code organization.
 
 ## Features
 
@@ -52,7 +51,7 @@ Requires-Dist: build>=0.8.0; extra == "dev"
 
 ## Installation
 
-You can install Django API Versioning via pip:
+You can [install Django API Versioning](https://pypi.org/project/django-api-versioning/) via pip:
 
 ```bash
 pip install django-api-versioning
@@ -106,7 +105,6 @@ or you have already have a `ROOT_URLCONF` in settings, you only need to import t
 
 The `endpoint` decorator can be used in both function-based views (FBVs) and class-based views (CBVs). It's also fully compatible with `Django Rest Framework (DRF)`. The decorator allows you to define versioning for your API views and supports backward compatibility by default and you don't need to pass `backward=True` flag to the `endpoint` decorator.
 
-
 #### Example for Function-Based Views (FBVs):
 
 ```python
@@ -121,6 +119,7 @@ def users_view(request):
 In this example, the `users_view` function is decorated with the endpoint decorator. This specifies that the view is accessible under version `2` of the API and **supports backward compatibility**. The `backward=True` flag as default ensures that users can also access the previous version (version `1`) at `/api/v1/account_app/users`.
 
 #### Example for Class-Based Views (CBVs):
+
 For class-based views, you can apply the decorator to methods such as `get`, `post`, or any other HTTP method you need to handle. Here’s an example:
 
 ```python
@@ -141,7 +140,6 @@ class UsersView(View):
 
 If you have already installed [Django Rest Framework](https://www.django-rest-framework.org/#installation), the `endpoint` decorator can be easily applied to APIView or viewsets. Here’s an example with a DRF APIView:
 
-
 ```python
 from rest_framework.views import APIView
 from rest_framework.response import Response
@@ -155,25 +153,26 @@ class UsersAPIView(APIView):
 ```
 
 #### URL Generation Based on Versioning:
+
 Once the decorator is applied, the URLs for your API will be generated based on the version specified in the decorator. For example, if the `API_MIN_VERSION` in your settings.py is set to `1` and the version in the decorator is set to `2`, the following URLs will be available:
 
-* `/api/v1/account_app/users`
-* `/api/v2/account_app/users`
+- `/api/v1/account_app/users`
+- `/api/v2/account_app/users`
 
 The `API_MIN_VERSION` setting ensures that users can access the API using different versions, providing backward compatibility. You can adjust which versions are considered valid by modifying the `API_MIN_VERSION` and `version` numbers in the decorators.
 
 #### Additional Configuration Options:
 
 **Without `app_name`:** If you don't pass `app_name` in the decorator, like this:
+
 ```python
 @endpoint("users", version=2, view_name="users_list_api")
 ```
 
 The generated URLs will be:
 
-* `/api/v1/users`
-* `/api/v2/users`
-
+- `/api/v1/users`
+- `/api/v2/users`
 
 **Without `version`:** If you don't pass `version` in the decorator, like this:
 
@@ -183,7 +182,7 @@ The generated URLs will be:
 
 API versioning will be disabled (`API_BASE_PATH` as prefix will be removed) for that view. The only URL generated will be:
 
-* `/users`
+- `/users`
 
 **Setting `backward=False`:** By default, the `backward` parameter is set to `True`, which ensures backward compatibility. If you explicitly set `backward=False`, like this:
 
@@ -193,7 +192,7 @@ API versioning will be disabled (`API_BASE_PATH` as prefix will be removed) for
 
 The generated URL will be only version 2:
 
-* `api/v2/users`
+- `api/v2/users`
 
 4. Run the Server:
 
@@ -202,16 +201,21 @@ python manage.py runserver
 ```
 
 ## Notes
+
 ### 1. `API_BASE_PATH` in settings Must Include ‍‍`{version}`:
+
 The `API_BASE_PATH` should always include `{version}` to ensure proper API versioning. This is important for correctly mapping API routes to different versions.
 
 ### 2. Using `app_name` in the `endpoint` decorator:
+
 It's recommended to fill in the `app_name` in the `endpoint` decorator to make the API URLs **more unique and organized**. This ensures that the routes are scoped under the correct app, avoiding potential conflicts and making them easier to manage.
 
 ### 3. Views with Version Less Than `API_MIN_VERSION` Are Automatically Ignored:
+
 Any view whose `version` is less than the `API_MIN_VERSION` will be automatically ignored. This means clients will no longer have access to these older versions, **without the need to manually edit or remove code**. This is handled automatically by the package.
 
 ### 4. URLs for Versions Between `API_MIN_VERSION` <= `version` <= `API_MAX_VERSION`:
+
 Endpoints that have versions within the range defined by `API_MIN_VERSION` <= `version` <= `API_MAX_VERSION` will always have a corresponding URL generated. This ensures that only valid versions will be accessible, providing flexibility in version management.
 
 ### `endpoint` Decorator Function Definition
@@ -232,7 +236,7 @@ def endpoint(
     - Uses `API_MIN_VERSION` and `API_MAX_VERSION` from Django settings.
     - Supports backward compatibility by registering multiple versions if needed.
     - Ensures that no version lower than `API_MIN_VERSION` is registered.
-    
+
     Args:
         postfix (str): The endpoint suffix (e.g., "users" → "api/v1/users").
         version (Optional[int]): The version of the API. Defaults to None (unversioned).
@@ -249,7 +253,6 @@ def endpoint(
     """
 ```
 
-
 ## Contributing
 
 Feel free to open an issue or submit a pull request with any improvements or bug fixes. We appreciate contributions to enhance this package!

{django_api_versioning-0.1.0.dist-info → django_api_versioning-0.1.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
 django_api_versioning/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_api_versioning/decorators.py,sha256=BC_7ZQwCDq3BjPdcNw-Efdh09kHv3uDjZEW1nGgcNog,3732
+django_api_versioning/decorators.py,sha256=YHyIapxlaQ3IgZnkdjjJ7QXaZxsMFjq-2TY12a5pXAA,3888
 django_api_versioning/exceptions.py,sha256=MgCpaNBsD8laQoVIVK823_t1liQ82K_uqguuA60PxXQ,485
 django_api_versioning/registry.py,sha256=FCRTHGyl995U1kLlxtIBp3lb62v-6AbSK9k3orzZxWA,1140
-django_api_versioning/settings.py,sha256=rasiYFuKM0EUYqzrpIphHGPEYb209uz56pEKR59R8w4,3006
+django_api_versioning/settings.py,sha256=8p57CIEQR65luxU7xo-eYdH-lSGGk3-BQFMVRRFG2pY,2975
 django_api_versioning/urls.py,sha256=B8UBYSXdyq_xTpWeN5zzH2SQzKiqZQMx3WFBrsu93X0,144
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_decorators.py,sha256=G2G3PR_QAPNyJuaw7H9BMARSOK8C6GJlHRAL3KmTuCY,3587
@@ -10,8 +10,8 @@ tests/test_exceptions.py,sha256=fsyfA7ouIMqz6Emexqo_oB7oVEZlhqptNmwH8KX37s8,863
 tests/test_registry.py,sha256=KQT6yWkfKZmcLShFkidHwfJfPi8yHN5i9xuzC3vqDso,2634
 tests/test_settings.py,sha256=SjieOTnwHdU0E6A2-qLE3iXG5osY3qacbAzJJ7tqD-0,5213
 tests/test_urls.py,sha256=DA8DbIEAYX812Re2PlTkL1OpkwCO2IZ1vW_QMh2d9nI,1207
-django_api_versioning-0.1.0.dist-info/LICENSE,sha256=iDPJdze6sBlBBSoB-BIyT2iHfHDGUAaZG3nTFd6m2FQ,1070
-django_api_versioning-0.1.0.dist-info/METADATA,sha256=B5McJrgZzySQghhKtqCvLMfBABI_TjgIFX8zHAnidS4,10436
-django_api_versioning-0.1.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-django_api_versioning-0.1.0.dist-info/top_level.txt,sha256=F4n1zaE6P--9OytuMrvCD50vn7NvIVWkIl6ie9fsFck,28
-django_api_versioning-0.1.0.dist-info/RECORD,,
+django_api_versioning-0.1.1.dist-info/LICENSE,sha256=iDPJdze6sBlBBSoB-BIyT2iHfHDGUAaZG3nTFd6m2FQ,1070
+django_api_versioning-0.1.1.dist-info/METADATA,sha256=vJvAL-_cghuGe-GbXQ1KyqjGE-xcfGcpifb-gRi5jRg,10679
+django_api_versioning-0.1.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+django_api_versioning-0.1.1.dist-info/top_level.txt,sha256=F4n1zaE6P--9OytuMrvCD50vn7NvIVWkIl6ie9fsFck,28
+django_api_versioning-0.1.1.dist-info/RECORD,,