djresttoolkit 0.17.0__tar.gz → 0.17.1__tar.gz

djresttoolkit-0.17.1/.python-version

@@ -0,0 +1 @@
+3.13

djresttoolkit-0.17.1/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "files.exclude": {
+        "**/.git": true,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/.DS_Store": true,
+        "**/Thumbs.db": true,
+        "**/__pycache__": true,
+        "**/.pytest_cache": true,
+        "**/.ruff_cache": true
+    }
+}

{djresttoolkit-0.17.0 → djresttoolkit-0.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.17.0
+Version: 0.17.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

djresttoolkit-0.17.1/demo/apps/todos/admin.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib import admin
+from django.contrib.admin import ModelAdmin
+
+from .models import Tag, Todo, TodoTag
+
+if TYPE_CHECKING:
+    class TodoAdminBase(ModelAdmin[Todo]): ...
+    class TagAdminBase(ModelAdmin[Todo]): ...
+    class TodoTagAdminBase(ModelAdmin[Todo]): ...
+else:
+    class TodoAdminBase(ModelAdmin): ... 
+    class TagAdminBase(ModelAdmin): ...
+    class TodoTagAdminBase(ModelAdmin): ...
+
+
+@admin.register(Todo)
+class TodoAdmin(TodoAdminBase):
+    list_display = [
+        "id",
+        "user",
+        "title",
+        "due_date",
+        "priority",
+        "status",
+    ]
+    list_display_links = list_display
+    ordering = ("-id",)
+    list_filter = ["priority", "status"]
+    search_fields = ["title"]
+
+
+@admin.register(Tag)
+class TagAdmin(TagAdminBase):
+    list_display = ["id", "name"]
+    list_display_links = list_display
+    ordering = ("-id",)
+    search_fields = ["name"]
+
+
+@admin.register(TodoTag)
+class TodoTagAdmin(TodoTagAdminBase):
+    list_display = ["id", "todo", "tag"]
+    list_display_links = list_display
+    ordering = ("-id",)

djresttoolkit-0.17.1/demo/apps/todos/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class TodosConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "apps.todos"
+    label = "todos"

djresttoolkit-0.17.1/demo/apps/todos/dbseed/tag_seed.py

@@ -0,0 +1,13 @@
+from djresttoolkit.dbseed.models import (  # type: ignore[import-not-found]
+    Field,
+    Gen,
+    SeedModel,
+)
+
+from ..models import Tag
+
+
+class TagSeedModel(SeedModel):
+    __model__ = Tag
+
+    name: str = Field(default_factory=Gen.word)

djresttoolkit-0.17.1/demo/apps/todos/dbseed/todo_seed.py

@@ -0,0 +1,44 @@
+from django.utils import timezone
+
+from djresttoolkit.dbseed.models import (  # type: ignore[import-not-found]
+    Field,
+    Gen,
+    SeedModel,
+)
+
+from ..models import Todo, TodoPriority, TodoStatus
+
+
+class TodoSeedModel(SeedModel):
+    __model__ = Todo
+
+    title: str = Field(
+        default_factory=lambda: Gen.sentence(nb_words=4),
+    )
+    description: str = Field(
+        default_factory=lambda: Gen.sentence(nb_words=20),
+    )
+    due_date: str | None = Field(
+        default_factory=lambda: Gen.date_time_this_year(
+            before_now=False, after_now=True
+        )
+        .replace(tzinfo=timezone.get_current_timezone())
+        .isoformat(),
+    )
+    priority: str = Field(
+        default_factory=lambda: Gen.random_element(
+            elements=[choice[0] for choice in TodoPriority.choices]
+        ),
+    )
+    status: str = Field(
+        default_factory=lambda: Gen.random_element(
+            elements=[choice[0] for choice in TodoStatus.choices]
+        ),
+    )
+    completed_at: str | None = Field(
+        default_factory=lambda: Gen.date_time_this_year(
+            before_now=False, after_now=True
+        )
+        .replace(tzinfo=timezone.get_current_timezone())
+        .isoformat(),
+    )

djresttoolkit-0.17.1/demo/apps/todos/dbseed/todo_tag_seed.py

@@ -0,0 +1,22 @@
+from djresttoolkit.dbseed.models import (  # type: ignore[import-not-found]
+    Field,
+    Gen,
+    SeedModel,
+)
+
+from ..models import Tag, Todo, TodoTag
+
+
+class TodoTagSeedModel(SeedModel):
+    __model__ = TodoTag
+
+    todo: int = Field(
+        default_factory=lambda: Gen.random_element(
+            list(Todo.objects.all().values_list("id", flat=True))
+        )
+    )
+    tag: int = Field(
+        default_factory=lambda: Gen.random_element(
+            list(Tag.objects.all().values_list("id", flat=True))
+        )
+    )

djresttoolkit-0.17.1/demo/apps/todos/migrations/0001_initial.py

@@ -0,0 +1,131 @@
+# Generated by Django 5.2.5 on 2025-08-18 05:32
+
+import django.db.models.deletion
+import uuid
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Tag",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        editable=False, primary_key=True, serialize=False
+                    ),
+                ),
+                (
+                    "uuid",
+                    models.UUIDField(default=uuid.uuid4, editable=False, unique=True),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("name", models.CharField(max_length=50, unique=True)),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+        migrations.CreateModel(
+            name="Todo",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        editable=False, primary_key=True, serialize=False
+                    ),
+                ),
+                (
+                    "uuid",
+                    models.UUIDField(default=uuid.uuid4, editable=False, unique=True),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("title", models.CharField(max_length=255)),
+                ("description", models.TextField(blank=True, default="")),
+                ("due_date", models.DateTimeField(blank=True, null=True)),
+                (
+                    "priority",
+                    models.CharField(
+                        choices=[
+                            ("low", "Low"),
+                            ("medium", "Medium"),
+                            ("high", "High"),
+                            ("critical", "Critical"),
+                        ],
+                        default="medium",
+                        max_length=20,
+                    ),
+                ),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("pending", "Pending"),
+                            ("in_progress", "In Progress"),
+                            ("completed", "Completed"),
+                            ("archived", "Archived"),
+                        ],
+                        default="pending",
+                        max_length=20,
+                    ),
+                ),
+                ("completed_at", models.DateTimeField(blank=True, null=True)),
+                (
+                    "user",
+                    models.ForeignKey(
+                        help_text="Owner of this todo",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="todos",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+        migrations.CreateModel(
+            name="TodoTag",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "tag",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="tag_todos",
+                        to="todos.tag",
+                    ),
+                ),
+                (
+                    "todo",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="todo_tags",
+                        to="todos.todo",
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("todo", "tag")},
+            },
+        ),
+    ]

djresttoolkit-0.17.1/demo/apps/todos/models.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+
+import uuid
+from uuid import UUID
+
+from django.conf import settings
+from django.contrib.auth.models import AbstractUser
+from django.db.models import (
+    CASCADE,
+    BigAutoField,
+    CharField,
+    DateTimeField,
+    ForeignKey,
+    Model,
+    TextChoices,
+    TextField,
+    UUIDField,
+)
+from django.utils import timezone
+
+
+class TodoPriority(TextChoices):
+    LOW = "low", "Low"
+    MEDIUM = "medium", "Medium"
+    HIGH = "high", "High"
+    CRITICAL = "critical", "Critical"
+
+
+class TodoStatus(TextChoices):
+    PENDING = "pending", "Pending"
+    IN_PROGRESS = "in_progress", "In Progress"
+    COMPLETED = "completed", "Completed"
+    ARCHIVED = "archived", "Archived"
+
+
+class BaseModel(Model):
+    """Abstract base with UUID PK and timestamps."""
+
+    id: BigAutoField[int, int] = BigAutoField(primary_key=True, editable=False)
+    uuid: UUIDField[UUID, str] = UUIDField(
+        unique=True,
+        default=uuid.uuid4,
+        editable=False,
+    )
+    created_at: DateTimeField[str, str] = DateTimeField(auto_now_add=True)
+    updated_at: DateTimeField[str, str] = DateTimeField(auto_now=True)
+
+    class Meta:
+        abstract = True
+
+
+class Todo(BaseModel):
+    """Main Todo model."""
+
+    user: ForeignKey[int, AbstractUser] = ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=CASCADE,
+        related_name="todos",
+        help_text="Owner of this todo",
+    )
+    title: CharField[str, str] = CharField(max_length=255)
+    description: TextField[str, str] = TextField(blank=True, default="")
+    due_date: DateTimeField[str | None, str | None] = DateTimeField(
+        null=True,
+        blank=True,
+    )
+
+    priority: CharField[str, str] = CharField(
+        max_length=20,
+        choices=TodoPriority.choices,
+        default=TodoPriority.MEDIUM,
+    )
+    status: CharField[str, str] = CharField(
+        max_length=20,
+        choices=TodoStatus.choices,
+        default=TodoStatus.PENDING,
+    )
+
+    completed_at: DateTimeField[str | None, str | None] = DateTimeField(
+        null=True,
+        blank=True,
+    )
+
+    def mark_completed(self) -> None:
+        """Mark todo as completed safely."""
+        self.status = TodoStatus.COMPLETED
+        self.completed_at = str(timezone.now())
+        self.save(update_fields=["status", "completed_at", "updated_at"])
+
+    def __str__(self) -> str:
+        return f"Todo({self.id}, {self.title})"
+
+
+class Tag(BaseModel):
+    """Simple tags for todos."""
+
+    name: CharField[str, str] = CharField(max_length=50, unique=True)
+
+    def __str__(self) -> str:
+        return f"Tag({self.id}, {self.name})"
+
+
+class TodoTag(Model):
+    """Many-to-many through model for tagging."""
+
+    todo: ForeignKey[int, Todo] = ForeignKey(
+        Todo,
+        on_delete=CASCADE,
+        related_name="todo_tags",
+    )
+    tag: ForeignKey[int, Tag] = ForeignKey(
+        Tag,
+        on_delete=CASCADE,
+        related_name="tag_todos",
+    )
+
+    class Meta:
+        unique_together = ("todo", "tag")

djresttoolkit-0.17.1/demo/apps/todos/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

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

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

djresttoolkit-0.17.1/demo/apps_config/asgi.py

@@ -0,0 +1,10 @@
+import os
+
+# Import Django's ASGI handler
+from django.core.asgi import get_asgi_application
+
+# Configure Django settings module path
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "apps_config.settings")
+
+# Create ASGI application instance
+application = get_asgi_application()

djresttoolkit-0.17.1/demo/apps_config/serializers.py

@@ -0,0 +1,7 @@
+from django.contrib.auth.models import User
+from rest_framework.serializers import CharField, Serializer
+
+
+class RetrieveTokenSerializer(Serializer[User]):
+    username = CharField(required=True)
+    password = CharField(write_only=True, required=True)

djresttoolkit-0.17.1/demo/apps_config/settings.py

@@ -0,0 +1,248 @@
+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
+
+# Add `src` to PYTHONPATH so "djresttoolkit" is importable
+# --------------------------------------------------------
+SRC_DIR = BASE_DIR / "src"
+sys.path.insert(0, str(SRC_DIR))
+
+# Security Configuration Settings
+# -------------------------------
+SECRET_KEY = env_settings.secret_key
+
+# DEBUG Configuration Settings
+# ----------------------------
+DEBUG = True
+
+# Allowed Host Configuration Settings
+# -----------------------------------
+ALLOWED_HOSTS = env_settings.allowed_hosts
+
+# Configure CORS Settings
+# -----------------------
+CORS_ALLOWED_ORIGINS = env_settings.cors_allowed_origins
+
+# Login Redirect URL Configuration Setting
+# ----------------------------------------
+LOGIN_REDIRECT_URL = "/"
+LOGOUT_REDIRECT_URL = LOGIN_REDIRECT_URL
+
+# Django built-in applications settings
+# -------------------------------------
+INSTALLED_APPS = [
+    "daphne",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+# Third-party applications Settings
+# ---------------------------------
+INSTALLED_APPS.extend(
+    [
+        "rest_framework",
+        "rest_framework.authtoken",
+        "corsheaders",
+    ]
+)
+
+# User Define applications Settings
+# ---------------------------------
+INSTALLED_APPS.extend(
+    [
+        "djresttoolkit",
+        "apps.todos.apps.TodosConfig",
+    ]
+)
+
+# Middleware Configuration Settings
+# ---------------------------------
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "corsheaders.middleware.CorsMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "djresttoolkit.middlewares.ResponseTimeMiddleware",
+]
+
+# Root urls file Configuration Settings
+# -------------------------------------
+ROOT_URLCONF = "apps_config.urls"
+
+# Templates Configuration Settings
+# --------------------------------
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [BASE_DIR / "templates"],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+# Application Server Configuration Setting
+# ----------------------------------------
+ASGI_APPLICATION = "apps_config.asgi.application"
+
+# User Model Configuration Setting
+# --------------------------------
+AUTH_USER_MODEL = "auth.User"
+
+# Default primary key field type Configuration Setting
+# ----------------------------------------------------
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# SQLite Database Configuration for development environment
+# ---------------------------------------------------------
+DATABASES: dict[str, dict[str, object]] = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "demo" / "db.sqlite3",
+    }
+}
+
+# Password Validators Configuration Settings
+# ------------------------------------------
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
+    },
+    {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
+    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
+    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
+]
+
+# Password hashing algorithms in order of preference
+# Using multiple algorithms provides additional security layers
+# -------------------------------------------------------------
+PASSWORD_HASHERS = [
+    "django.contrib.auth.hashers.PBKDF2PasswordHasher",
+    "django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher",
+    "django.contrib.auth.hashers.BCryptSHA256PasswordHasher",
+    "django.contrib.auth.hashers.ScryptPasswordHasher",
+    "django.contrib.auth.hashers.Argon2PasswordHasher",
+]
+
+# Internationalization Configuration Settings
+# -------------------------------------------
+LANGUAGE_CODE = "en-us"
+TIME_ZONE = "UTC"
+USE_I18N = True
+USE_TZ = True
+
+# Static files (CSS, JavaScript, Images)
+# STATIC AND MEDIA FILES Configuration Settings
+# ---------------------------------------------
+STATIC_URL = "/demo/static/"
+STATIC_ROOT = BASE_DIR / "demo" / "staticfiles"
+STATICFILES_DIRS = [BASE_DIR / "demo" / "static"]
+
+# Configure media files (User-uploaded files)
+# -------------------------------------------
+MEDIA_ROOT = BASE_DIR / "uploads"
+MEDIA_URL = "/media/"
+
+# REST Framework Configuration Settings
+# -------------------------------------
+REST_FRAMEWORK = {
+    "NON_FIELD_ERRORS_KEY": "non_field",
+    "DEFAULT_AUTHENTICATION_CLASSES": [
+        "rest_framework.authentication.TokenAuthentication",
+    ],
+    "DEFAULT_PERMISSION_CLASSES": [
+        "rest_framework.permissions.IsAuthenticated",
+    ],
+    "DEFAULT_PARSER_CLASSES": [
+        "rest_framework.parsers.JSONParser",
+        "rest_framework.parsers.MultiPartParser",
+    ],
+    "DEFAULT_RENDERER_CLASSES": [
+        "djresttoolkit.renderers.ThrottleInfoJSONRenderer",
+        "rest_framework.renderers.BrowsableAPIRenderer",
+    ],
+    "DEFAULT_THROTTLE_CLASSES": [
+        "rest_framework.throttling.AnonRateThrottle",
+    ],
+    "DEFAULT_THROTTLE_RATES": {
+        "anon": "100/day",
+        "user": "1000/day",
+    },
+    "DEFAULT_FILTER_BACKENDS": [
+        "django_filters.rest_framework.DjangoFilterBackend",
+    ],
+    "EXCEPTION_HANDLER": "djresttoolkit.views.exception_handler",
+    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
+    "PAGE_SIZE": 4,
+    "MAX_PAGE_SIZE": 8,
+}
+
+# Authentication Configuration Settings
+# -------------------------------------
+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,
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_redis.client.DefaultClient",
+        },
+    }
+}
+
+# Celery Configuration Settings
+# -----------------------------
+# Redis as broker
+CELERY_BROKER_URL = "redis://localhost:6379/0"
+
+# Where results are stored
+CELERY_RESULT_BACKEND = "redis://localhost:6379/0"
+
+# Recommended settings
+CELERY_ACCEPT_CONTENT = ["json"]
+CELERY_TASK_SERIALIZER = "json"
+CELERY_RESULT_SERIALIZER = "json"
+CELERY_TIMEZONE = TIME_ZONE
+
+# Task time limits (avoid runaway tasks)
+CELERY_TASK_TIME_LIMIT = 30 * 60  # 30 mins
+CELERY_TASK_SOFT_TIME_LIMIT = 25 * 60