djresttoolkit 0.17.5__tar.gz → 1.1.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.17.5
+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
@@ -47,9 +47,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.13
 Requires-Dist: faker>=37.5.3
-Requires-Dist: pydantic-settings>=2.10.1
 Requires-Dist: pydantic>=2.11.7
-Requires-Dist: pyyaml>=6.0.2
 Provides-Extra: dev
 Requires-Dist: mypy; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
@@ -72,8 +70,8 @@ djresttoolkit is a collection of utilities and helpers for Django and Django RES
 - **DB Flush Command (`dbflush`)**
   Management command to flush all models or a specific model, resetting auto-increment IDs safely with transaction support.
 
-- **EnvBaseSettings**
-  Typed settings loader using **YAML + .env**, supports nested keys and overrides. Great for structured configuration management.
+- **BaseEnvConfig**
+  Singleton environment loader that reads and parses environment variables.
 
 - **EmailSender**
   Custom class to send templated emails (`text` and `html`) with context. Supports error handling and logging.
@@ -186,10 +184,6 @@ python manage.py dbseed --count 10
 python manage.py dbseed --model User --seed 42
 ```
 
-Here’s a **concise API reference** for your database flush management command for `djresttoolkit`:
-
----
-
 ### 2. DB Flush Command — API Reference
 
 ```python
@@ -246,77 +240,54 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-### 3. EnvBaseSettings — API Reference
+### 3. BaseEnvConfig — API Reference
 
 ```python
-from djresttoolkit.envconfig import EnvBaseSettings
+from djresttoolkit.envconfig import BaseEnvConfig
 ```
 
-#### `EnvBaseSettings`
-
-A **base settings class** for managing application configuration using:
-
-- YAML files (default `.environ.yaml`)
-- Environment variables (default `.env`)
-
-Supports **nested configuration** using double underscores (`__`) in environment variable names.
-
-#### Class Attributes
-
-- Attributes
-  - `env_file`
-    - Type: `str`
-    - Default: `.env`
-    - Description: Environment variable file path.
-  - `yaml_file`
-    - Type: `str`
-    - Default: `.environ.yaml`
-    - Description: YAML configuration file path.
-  - `model_config`
-    - Type: `SettingsConfigDict`
-    - Description: Pydantic settings configuration (file encoding, nested delimiter).
-
-#### Methods
+#### `BaseEnvConfig`
 
-#### `load(cls, *, env_file: str | None = None, ymal_file: str | None = None, warning: bool = True) -> EnvBaseSettings`
+Singleton environment loader that reads and parses environment variables with support for booleans, numbers, and JSON.
 
-Loads configuration from **YAML first**, then overrides with **environment variables**.
+> ⚠️ **Note:** Note: If you are using a .env file, load it first with python-dotenv:
+>
+> ```python
+> from dotenv import load_dotenv
+> load_dotenv()
+> ```
 
-#### Parameters
-
-- `env_file` — Optional custom `.env` file path.
-- `ymal_file` — Optional custom YAML file path.
-- `warning` — Emit a warning if YAML file is missing (default `True`).
-
-#### Returns
-
-- Instance of `EnvBaseSettings` (or subclass) with loaded configuration.
-
-#### Raises
-
-- `UserWarning` if YAML file not found and `warning=True`.
+or
+>
+> ```python
+> from djresttoolkit.envconfig import load_dotenv
+> load_dotenv()
+> ```
 
-### Usage Example
+#### Usage Example
 
 ```python
-from djresttoolkit.envconfig import EnvBaseSettings
+from djresttoolkit.envconfig import load_dotenv, BaseEnvConfig
 
-class EnvSettings(EnvBaseSettings["EnvSettings"]):
-    debug: bool = False
-    database_url: str
+load_dotenv()
 
-# Load settings
-settings = EnvSettings.load(warning=False)
+class EnvConfig(BaseEnvConfig):
+    DEBUG: bool = False
+    DATABASE_URL: str
 
-print(settings.debug)
-print(settings.database_url)
+config = EnvConfig()
+print(config.DEBUG)
+print(config.DATABASE_URL)
+
+config.reload()
 ```
 
 #### Features
 
-- Prioritizes `.env` variables over YAML.
-- Supports nested keys: `DATABASE__HOST`:- `settings.database.host`.
-- Designed to be subclassed for project-specific settings.
+- Thread-safe singleton.
+- Automatic type parsing for environment variables.
+- Supports default values and runtime reloading.
+- Designed for subclassing with project-specific settings.
 
 ### 4. EmailSender — API Reference
 
@@ -830,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
@@ -837,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-0.17.5 → djresttoolkit-1.1.0}/README.md

@@ -14,8 +14,8 @@ djresttoolkit is a collection of utilities and helpers for Django and Django RES
 - **DB Flush Command (`dbflush`)**
   Management command to flush all models or a specific model, resetting auto-increment IDs safely with transaction support.
 
-- **EnvBaseSettings**
-  Typed settings loader using **YAML + .env**, supports nested keys and overrides. Great for structured configuration management.
+- **BaseEnvConfig**
+  Singleton environment loader that reads and parses environment variables.
 
 - **EmailSender**
   Custom class to send templated emails (`text` and `html`) with context. Supports error handling and logging.
@@ -128,10 +128,6 @@ python manage.py dbseed --count 10
 python manage.py dbseed --model User --seed 42
 ```
 
-Here’s a **concise API reference** for your database flush management command for `djresttoolkit`:
-
----
-
 ### 2. DB Flush Command — API Reference
 
 ```python
@@ -188,77 +184,54 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-### 3. EnvBaseSettings — API Reference
+### 3. BaseEnvConfig — API Reference
 
 ```python
-from djresttoolkit.envconfig import EnvBaseSettings
+from djresttoolkit.envconfig import BaseEnvConfig
 ```
 
-#### `EnvBaseSettings`
-
-A **base settings class** for managing application configuration using:
-
-- YAML files (default `.environ.yaml`)
-- Environment variables (default `.env`)
-
-Supports **nested configuration** using double underscores (`__`) in environment variable names.
-
-#### Class Attributes
-
-- Attributes
-  - `env_file`
-    - Type: `str`
-    - Default: `.env`
-    - Description: Environment variable file path.
-  - `yaml_file`
-    - Type: `str`
-    - Default: `.environ.yaml`
-    - Description: YAML configuration file path.
-  - `model_config`
-    - Type: `SettingsConfigDict`
-    - Description: Pydantic settings configuration (file encoding, nested delimiter).
-
-#### Methods
+#### `BaseEnvConfig`
 
-#### `load(cls, *, env_file: str | None = None, ymal_file: str | None = None, warning: bool = True) -> EnvBaseSettings`
+Singleton environment loader that reads and parses environment variables with support for booleans, numbers, and JSON.
 
-Loads configuration from **YAML first**, then overrides with **environment variables**.
+> ⚠️ **Note:** Note: If you are using a .env file, load it first with python-dotenv:
+>
+> ```python
+> from dotenv import load_dotenv
+> load_dotenv()
+> ```
 
-#### Parameters
-
-- `env_file` — Optional custom `.env` file path.
-- `ymal_file` — Optional custom YAML file path.
-- `warning` — Emit a warning if YAML file is missing (default `True`).
-
-#### Returns
-
-- Instance of `EnvBaseSettings` (or subclass) with loaded configuration.
-
-#### Raises
-
-- `UserWarning` if YAML file not found and `warning=True`.
+or
+>
+> ```python
+> from djresttoolkit.envconfig import load_dotenv
+> load_dotenv()
+> ```
 
-### Usage Example
+#### Usage Example
 
 ```python
-from djresttoolkit.envconfig import EnvBaseSettings
+from djresttoolkit.envconfig import load_dotenv, BaseEnvConfig
 
-class EnvSettings(EnvBaseSettings["EnvSettings"]):
-    debug: bool = False
-    database_url: str
+load_dotenv()
 
-# Load settings
-settings = EnvSettings.load(warning=False)
+class EnvConfig(BaseEnvConfig):
+    DEBUG: bool = False
+    DATABASE_URL: str
 
-print(settings.debug)
-print(settings.database_url)
+config = EnvConfig()
+print(config.DEBUG)
+print(config.DATABASE_URL)
+
+config.reload()
 ```
 
 #### Features
 
-- Prioritizes `.env` variables over YAML.
-- Supports nested keys: `DATABASE__HOST`:- `settings.database.host`.
-- Designed to be subclassed for project-specific settings.
+- Thread-safe singleton.
+- Automatic type parsing for environment variables.
+- Supports default values and runtime reloading.
+- Designed for subclassing with project-specific settings.
 
 ### 4. EmailSender — API Reference
 
@@ -772,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
@@ -779,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-0.17.5 → 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-0.17.5 → djresttoolkit-1.1.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "0.17.5"
+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" }
@@ -48,8 +48,6 @@ requires-python = ">=3.13"
 dependencies = [
     "faker>=37.5.3",
     "pydantic>=2.11.7",
-    "pydantic-settings>=2.10.1",
-    "pyyaml>=6.0.2",
 ]
 
 # CLI scripts entry point configuration

djresttoolkit-1.1.0/src/djresttoolkit/envconfig/__init__.py

@@ -0,0 +1,4 @@
+from ._base_env_config import BaseEnvConfig
+from dotenv import load_dotenv
+
+__all__ = ["load_dotenv", "BaseEnvConfig"]

djresttoolkit-1.1.0/src/djresttoolkit/envconfig/_base_env_config.py

@@ -0,0 +1,84 @@
+import threading
+import json
+from os import getenv
+from typing import Any, Self, get_type_hints
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class BaseEnvConfig:
+    """Production-ready environment loader."""
+
+    _instance_lock = threading.Lock()
+    _instance = None
+
+    def __new__(cls, *args: Any, **kwargs: Any) -> Self:
+        if cls._instance is None:
+            with cls._instance_lock:
+                if cls._instance is None:
+                    cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(self) -> None:
+        if getattr(self, "_initialized", False):
+            return
+
+        self._env_cache: dict[str, Any] = {}
+        self._sync_env()
+        self._initialized = True
+
+    def _sync_env(self) -> None:
+        hints = get_type_hints(self.__class__)
+        for field, _ in hints.items():
+            raw = getenv(field)
+
+            if raw is None:
+                if hasattr(self, field):
+                    value = getattr(self, field)
+                    logger.info(f"{field} not set, using default: {value}")
+                else:
+                    raise EnvironmentError(
+                        f"Missing required environment variable: {field}"
+                    )
+            else:
+                if field in self._env_cache:
+                    value = self._env_cache[field]
+                else:
+                    value = self._parse_env_value(raw)
+                    self._env_cache[field] = value
+
+            setattr(self, field, value)
+
+    def _parse_env_value(self, raw: str) -> Any:
+        """Parse string from environment."""
+        lowered = raw.lower()
+
+        # Boolean parsing
+        if lowered == "true":
+            return True
+        if lowered == "false":
+            return False
+
+        # JSON parsing
+        try:
+            return json.loads(raw)
+        except json.JSONDecodeError:
+            pass
+
+        # Numeric parsing
+        if raw.isdigit():
+            return int(raw)
+        try:
+            return float(raw)
+        except ValueError:
+            pass
+
+        # Fallback: plain string
+        return raw
+
+    def reload(self) -> None:
+        """Reload environment variables at runtime."""
+        self._env_cache.clear()
+        self._sync_env()
+        logger.info("Environment variables reloaded.")

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-0.17.5 → djresttoolkit-1.1.0}/uv.lock

@@ -342,13 +342,11 @@ wheels = [
 
 [[package]]
 name = "djresttoolkit"
-version = "0.8.0"
+version = "1.0.0"
 source = { editable = "." }
 dependencies = [
     { name = "faker" },
     { name = "pydantic" },
-    { name = "pydantic-settings" },
-    { name = "pyyaml" },
 ]
 
 [package.optional-dependencies]
@@ -380,9 +378,7 @@ requires-dist = [
     { name = "faker", specifier = ">=37.5.3" },
     { name = "mypy", marker = "extra == 'dev'" },
     { name = "pydantic", specifier = ">=2.11.7" },
-    { name = "pydantic-settings", specifier = ">=2.10.1" },
     { name = "pytest", marker = "extra == 'dev'" },
-    { name = "pyyaml", specifier = ">=6.0.2" },
     { name = "ruff", marker = "extra == 'dev'" },
 ]
 provides-extras = ["dev"]

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

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

djresttoolkit-0.17.5/demo/env_config/__init__.py

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