djresttoolkit 1.0.0__tar.gz → 1.1.0__tar.gz

{djresttoolkit-1.0.0 → djresttoolkit-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 1.0.0
+Version: 1.1.0
 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
@@ -240,7 +240,7 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-###  3. BaseEnvConfig — API Reference
+### 3. BaseEnvConfig — API Reference
 
 ```python
 from djresttoolkit.envconfig import BaseEnvConfig
@@ -801,6 +801,7 @@ Retrieve a single model object using the provided filter criteria.
 
 ```python
 from rest_framework.views import APIView
+from rest_framework.response import Respone
 from django.http import JsonResponse
 from myapp.models import Book
 from djresttoolkit.mixins import RetrieveObjectMixin
@@ -808,17 +809,18 @@ from djresttoolkit.mixins import RetrieveObjectMixin
 class BookDetailView(RetrieveObjectMixin[Book], APIView):
     queryset = Book.objects.all()
 
-    def get(self, request, *args, **kwargs):
+    def not_found_detail(self) -> dict[str, str] | str:
+        return  "The requested Book was not found."
+
+    def get(self, request, *args, **kwargs) -> Respone:
         book = self.get_object(id=kwargs["id"])
-        if book:
-            return JsonResponse({"title": book.title, "author": book.author})
-        return JsonResponse({"detail": "Not found"}, status=404)
+        return Respone({"title": book.title, "author": book.author})
 ```
 
 #### Features of Retrieve Object Mixin
 
 - Simplifies object retrieval in class-based views or DRF views.
-- Returns `None` instead of raising `DoesNotExist`, making error handling easier.
+- Raise `http404` if requested resource does not extst.
 - Works with any Django model and queryset.
 
 ### 13. build_absolute_uri — API Reference

{djresttoolkit-1.0.0 → djresttoolkit-1.1.0}/README.md

@@ -184,7 +184,7 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-###  3. BaseEnvConfig — API Reference
+### 3. BaseEnvConfig — API Reference
 
 ```python
 from djresttoolkit.envconfig import BaseEnvConfig
@@ -745,6 +745,7 @@ Retrieve a single model object using the provided filter criteria.
 
 ```python
 from rest_framework.views import APIView
+from rest_framework.response import Respone
 from django.http import JsonResponse
 from myapp.models import Book
 from djresttoolkit.mixins import RetrieveObjectMixin
@@ -752,17 +753,18 @@ from djresttoolkit.mixins import RetrieveObjectMixin
 class BookDetailView(RetrieveObjectMixin[Book], APIView):
     queryset = Book.objects.all()
 
-    def get(self, request, *args, **kwargs):
+    def not_found_detail(self) -> dict[str, str] | str:
+        return  "The requested Book was not found."
+
+    def get(self, request, *args, **kwargs) -> Respone:
         book = self.get_object(id=kwargs["id"])
-        if book:
-            return JsonResponse({"title": book.title, "author": book.author})
-        return JsonResponse({"detail": "Not found"}, status=404)
+        return Respone({"title": book.title, "author": book.author})
 ```
 
 #### Features of Retrieve Object Mixin
 
 - Simplifies object retrieval in class-based views or DRF views.
-- Returns `None` instead of raising `DoesNotExist`, making error handling easier.
+- Raise `http404` if requested resource does not extst.
 - Works with any Django model and queryset.
 
 ### 13. build_absolute_uri — API Reference

djresttoolkit-1.1.0/demo/apps/todos/urls.py

@@ -0,0 +1,11 @@
+"""
+URL configuration for todos app.
+"""
+
+from django.urls import path
+
+from .views import TodoDetailView
+
+urlpatterns = [
+    path("<int:id>/", TodoDetailView.as_view(), name="todo-detail"),
+]

djresttoolkit-1.1.0/demo/apps/todos/views.py

@@ -0,0 +1,18 @@
+from django.forms.models import model_to_dict
+from rest_framework.permissions import AllowAny
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from djresttoolkit.views.mixins import RetrieveObjectMixin
+
+from .models import Todo
+
+
+class TodoDetailView(RetrieveObjectMixin[Todo], APIView):
+    permission_classes = [AllowAny]
+    queryset = Todo.objects.all()
+
+    def get(self, request: Request, id: int) -> Response:
+        todo = self.get_object(id=id)
+        return Response(data=model_to_dict(todo))

{djresttoolkit-1.0.0 → djresttoolkit-1.1.0}/demo/apps_config/settings.py

@@ -1,8 +1,6 @@
 import sys
 from pathlib import Path
 
-from env_config import env_settings
-
 # Configuration Settings File for the django backend
 # --------------------------------------------------
 BASE_DIR = Path(__file__).resolve().parent.parent.parent
@@ -14,7 +12,7 @@ sys.path.insert(0, str(SRC_DIR))
 
 # Security Configuration Settings
 # -------------------------------
-SECRET_KEY = env_settings.secret_key
+SECRET_KEY = "asdkjasdjgasdgjioarejalk54884a651asdgklnaskdg"
 
 # DEBUG Configuration Settings
 # ----------------------------
@@ -22,11 +20,11 @@ DEBUG = True
 
 # Allowed Host Configuration Settings
 # -----------------------------------
-ALLOWED_HOSTS = env_settings.allowed_hosts
+ALLOWED_HOSTS = ["*"]
 
 # Configure CORS Settings
 # -----------------------
-CORS_ALLOWED_ORIGINS = env_settings.cors_allowed_origins
+# CORS_ALLOWED_ORIGINS = []
 
 # Login Redirect URL Configuration Setting
 # ----------------------------------------
@@ -200,29 +198,13 @@ REST_FRAMEWORK = {
 # -------------------------------------
 AUTHENTICATION_BACKENDS = ["django.contrib.auth.backends.ModelBackend"]
 
-# EMAIL Configuration Settings
-# ----------------------------
-EMAIL_BACKEND = env_settings.email.backend  # type: ignore[]
-EMAIL_HOST = env_settings.email.host
-EMAIL_PORT = env_settings.email.port
-EMAIL_USE_TLS = env_settings.email.use_tls
-EMAIL_USE_SSL = env_settings.email.use_ssl
-EMAIL_HOST_USER = env_settings.email.host_user
-EMAIL_HOST_PASSWORD = env_settings.email.host_password
-DEFAULT_FROM_EMAIL = env_settings.email.default_from_email
-
-# Google OAuth2 Configuration Settings
-# ------------------------------------
-GOOGLE_CLIENT_ID = env_settings.google.client_id
-GOOGLE_CLIENT_SECRET = env_settings.google.client_secret
-GOOGLE_REDIRECT_URI = env_settings.google.redirect_url
 
 # Redis configuration for production
 # ----------------------------------
 CACHES = {
     "default": {
         "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": env_settings.redis.cache_location,
+        "LOCATION": "redis://localhost:6379/1",
         "OPTIONS": {
             "CLIENT_CLASS": "django_redis.client.DefaultClient",
         },

{djresttoolkit-1.0.0 → djresttoolkit-1.1.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "1.0.0"
+version = "1.1.0"
 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.1.0/src/djresttoolkit/views/mixins/__init__.py

@@ -0,0 +1,3 @@
+from ._retrieve_object_mixin import RetrieveObjectMixin
+
+__all__ = ["RetrieveObjectMixin"]

djresttoolkit-1.1.0/src/djresttoolkit/views/mixins/_retrieve_object_mixin.py

@@ -0,0 +1,59 @@
+from typing import Any
+
+from django.core.exceptions import ImproperlyConfigured
+from django.db.models import Model, QuerySet
+from django.http import Http404
+
+
+class RetrieveObjectMixin[T: Model]:
+    """
+    Retrieve a single model object by filters.
+
+    Requires the `queryset` attribute to be set in the class that inherits this mixin.
+
+    Raises `Http404` when the object is missing.
+
+    This works in both Django views and DRF views.
+
+    Example:
+    ```
+        class MyView(RetrieveModelMixin[Book], APIView):
+            queryset = Book.objects.all()
+
+            def get(self, request, *args, **kwargs):
+                obj = self.get_object(id=1)
+                return JsonResponse(obj.to_dict())
+    ```
+    """
+
+    queryset: QuerySet[T] | None = None
+
+    def get_object(self, **filters: Any) -> T:
+        """Retrieve a model object based on provided filters."""
+
+        if self.queryset is None:
+            raise ImproperlyConfigured(
+                "Queryset attribute is not set in the class.",
+            )
+
+        try:
+            return self.queryset.get(**filters)
+        except self.queryset.model.DoesNotExist:
+            raise Http404(self.not_found_detail())
+
+    def not_found_detail(self) -> dict[str, str] | str:
+        """
+        Hook for customizing the 404 message.
+        Can be overridden per view.
+        """
+
+        if self.queryset is None:
+            raise ImproperlyConfigured(
+                "Queryset attribute is not set in the class.",
+            )
+
+        verbose_name = self.queryset.model._meta.verbose_name
+        model_name = (
+            verbose_name.title() if verbose_name else self.queryset.model.__name__
+        )
+        return f"The requested {model_name} was not found."

djresttoolkit-1.0.0/demo/apps/todos/urls.py

@@ -1,7 +0,0 @@
-"""
-URL configuration for todos app.
-"""
-
-from django.urls import path
-
-urlpatterns = []

djresttoolkit-1.0.0/demo/env_config/__init__.py

@@ -1,3 +0,0 @@
-from .env_settings import env_settings
-
-__all__ = ["env_settings"]

djresttoolkit-1.0.0/demo/env_config/env_settings.py

@@ -1,54 +0,0 @@
-from typing import Literal
-
-from pydantic import BaseModel
-
-from src.djresttoolkit.envconfig import EnvBaseSettings
-
-
-class DatabaseConfig(BaseModel):
-    engine: str
-    name: str
-    user: str
-    password: str
-    host: str
-    port: int
-
-
-class RedisConfig(BaseModel):
-    cache_location: str
-
-
-class EmailConfig(BaseModel):
-    backend: str
-    host: str
-    port: int
-    use_tls: bool
-    use_ssl: bool
-    host_user: str
-    host_password: str
-    default_from_email: str
-
-
-class GoogleOAuth2Config(BaseModel):
-    client_id: str
-    client_secret: str
-    redirect_url: str
-
-
-class EnvSettings(EnvBaseSettings["EnvSettings"]):
-    """Env Settings class to handle env loads."""
-
-    secret_key: str
-    host: str
-    port: int
-    environ: Literal["dev", "prod"]
-    allowed_hosts: list[str]
-    cors_allowed_origins: list[str]
-    database: DatabaseConfig
-    redis: RedisConfig
-    email: EmailConfig
-    google: GoogleOAuth2Config
-
-
-env_settings = EnvSettings.load(warning=False)
-

djresttoolkit-1.0.0/src/djresttoolkit/views/mixins/__init__.py

@@ -1,6 +0,0 @@
-from ._retrieve_object_mixin import RetrieveObjectMixin, QuerysetNotDefinedError
-
-__all__ = [
-    "RetrieveObjectMixin",
-    "QuerysetNotDefinedError",
-]

djresttoolkit-1.0.0/src/djresttoolkit/views/mixins/_retrieve_object_mixin.py

@@ -1,41 +0,0 @@
-from typing import Any
-from django.db.models import Model, QuerySet
-
-
-class QuerysetNotDefinedError(Exception):
-    """Exception raised when the `queryset` attribute is not set in the class."""
-
-    pass
-
-
-class RetrieveObjectMixin[T: Model]:
-    """
-    Mixin to provide a method for retrieving a single model object by filters.
-
-    Requires the `queryset` attribute to be set in the class that inherits this mixin.
-
-    Example:
-    ```
-        class MyView(RetrieveModelMixin[Book], APIView):
-            queryset = Book.objects.all()
-
-            def get(self, request, *args, **kwargs):
-                obj = self.get_object(id=1)
-                return JsonResponse(obj.to_dict())
-    ```
-    """
-
-    queryset: QuerySet[T] | None = None
-
-    def get_object(self, **filters: Any) -> T | None:
-        """Retrieve a model object based on provided filters."""
-
-        if self.queryset is None:
-            raise QuerysetNotDefinedError(
-                "Queryset attribute is not set in the class.",
-            )
-
-        try:
-            return self.queryset.get(**filters)
-        except self.queryset.model.DoesNotExist:
-            return None