djresttoolkit 0.6.0__py3-none-any.whl → 0.6.2__py3-none-any.whl

README.md

@@ -28,9 +28,64 @@ djresttoolkit is a collection of utilities and helpers for Django and Django RES
     pip install djresttoolkit
     ````
 
-## 📚 API Reference
+## 📚 All API Reference
 
-### 1. EmailSender
+### 1. DB Seed Utilities
+
+#### `Generator`
+
+```python
+from djresttoolkit.dbseed.models import Generator, Gen, Field
+```
+
+- `Gen`: Pre-initialized **Faker** instance for generating fake data.
+- `Field`: Alias for `pydantic.Field` to define seed model fields.
+
+#### Example
+
+```python
+from djresttoolkit.dbseed.models import SeedModel
+from myapp.models import User
+
+class UserSeedModel(SeedModel):
+    __model__ = User
+
+    username: str = Field(default_factory=lambda: Gen.user_name())
+    email: str = Field(default_factory=lambda: Gen.email())
+```
+
+#### `manage.py` Command: `dbseed`
+
+Seed the database from all `dbseed` directories in installed apps.
+
+```bash
+python manage.py dbseed [--count 5] [--model User] [--seed 42]
+```
+
+#### Options
+
+- `--count`: Number of records per model (default: 5).
+- `--model`: Specific model name to seed (optional).
+- `--seed`: Faker seed for reproducible data (optional).
+
+#### Behavior
+
+- Auto-discovers all `dbseed` models in installed apps.
+- Handles ForeignKey, OneToOneField, and ManyToMany relationships.
+- Uses transactions to ensure safe creation of records.
+- Logs errors for failed instance creation but continues seeding.
+
+#### Command Example
+
+```bash
+# Seed 10 records for all models
+python manage.py dbseed --count 10
+
+# Seed only the User model with fixed Faker seed
+python manage.py dbseed --model User --seed 42
+```
+
+### 2. EmailSender
 
 ```python
 from djresttoolkit.mail import EmailSender, EmailContent, EmailTemplate
@@ -56,7 +111,7 @@ send(to: list[str], exceptions: bool = False) -> bool
 - `exceptions`: raise on error if `True`, else logs error
 - Returns `True` if sent, `False` on failure
 
-#### Example
+#### Example for sending an email
 
 ```python
 content = EmailContent(
@@ -79,7 +134,7 @@ EmailSender(content).send(to=["user@example.com"])
 
 - `text`, `html` — template file paths
 
-### 2. Custom DRF Exception Handler
+### 3. Custom DRF Exception Handler
 
 ```python
 from djresttoolkit.views import exception_handler
@@ -119,7 +174,7 @@ REST_FRAMEWORK = {
 - Tracks requests in cache and calculates `retry_after`.
 - Cleans expired timestamps automatically.
 
-### 3. Response Time Middleware
+### 4. Response Time Middleware
 
 ```python
 from djresttoolkit.middlewares import ResponseTimeMiddleware
@@ -148,7 +203,7 @@ MIDDLEWARE = [
 ]
 ```
 
-#### Behavior
+#### Response Time Middleware Behavior
 
 - Measures the time taken to process each request.
 - Adds a header `X-Response-Time` to each HTTP response.
@@ -166,7 +221,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 4. Throttle Utilities
+### 5. Throttle Utilities
 
 #### `ThrottleInfoJSONRenderer`
 

{djresttoolkit-0.6.0.dist-info → djresttoolkit-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.6.0
+Version: 0.6.2
 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
@@ -84,9 +84,64 @@ djresttoolkit is a collection of utilities and helpers for Django and Django RES
     pip install djresttoolkit
     ````
 
-## 📚 API Reference
+## 📚 All API Reference
 
-### 1. EmailSender
+### 1. DB Seed Utilities
+
+#### `Generator`
+
+```python
+from djresttoolkit.dbseed.models import Generator, Gen, Field
+```
+
+- `Gen`: Pre-initialized **Faker** instance for generating fake data.
+- `Field`: Alias for `pydantic.Field` to define seed model fields.
+
+#### Example
+
+```python
+from djresttoolkit.dbseed.models import SeedModel
+from myapp.models import User
+
+class UserSeedModel(SeedModel):
+    __model__ = User
+
+    username: str = Field(default_factory=lambda: Gen.user_name())
+    email: str = Field(default_factory=lambda: Gen.email())
+```
+
+#### `manage.py` Command: `dbseed`
+
+Seed the database from all `dbseed` directories in installed apps.
+
+```bash
+python manage.py dbseed [--count 5] [--model User] [--seed 42]
+```
+
+#### Options
+
+- `--count`: Number of records per model (default: 5).
+- `--model`: Specific model name to seed (optional).
+- `--seed`: Faker seed for reproducible data (optional).
+
+#### Behavior
+
+- Auto-discovers all `dbseed` models in installed apps.
+- Handles ForeignKey, OneToOneField, and ManyToMany relationships.
+- Uses transactions to ensure safe creation of records.
+- Logs errors for failed instance creation but continues seeding.
+
+#### Command Example
+
+```bash
+# Seed 10 records for all models
+python manage.py dbseed --count 10
+
+# Seed only the User model with fixed Faker seed
+python manage.py dbseed --model User --seed 42
+```
+
+### 2. EmailSender
 
 ```python
 from djresttoolkit.mail import EmailSender, EmailContent, EmailTemplate
@@ -112,7 +167,7 @@ send(to: list[str], exceptions: bool = False) -> bool
 - `exceptions`: raise on error if `True`, else logs error
 - Returns `True` if sent, `False` on failure
 
-#### Example
+#### Example for sending an email
 
 ```python
 content = EmailContent(
@@ -135,7 +190,7 @@ EmailSender(content).send(to=["user@example.com"])
 
 - `text`, `html` — template file paths
 
-### 2. Custom DRF Exception Handler
+### 3. Custom DRF Exception Handler
 
 ```python
 from djresttoolkit.views import exception_handler
@@ -175,7 +230,7 @@ REST_FRAMEWORK = {
 - Tracks requests in cache and calculates `retry_after`.
 - Cleans expired timestamps automatically.
 
-### 3. Response Time Middleware
+### 4. Response Time Middleware
 
 ```python
 from djresttoolkit.middlewares import ResponseTimeMiddleware
@@ -204,7 +259,7 @@ MIDDLEWARE = [
 ]
 ```
 
-#### Behavior
+#### Response Time Middleware Behavior
 
 - Measures the time taken to process each request.
 - Adds a header `X-Response-Time` to each HTTP response.
@@ -222,7 +277,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 4. Throttle Utilities
+### 5. Throttle Utilities
 
 #### `ThrottleInfoJSONRenderer`
 

{djresttoolkit-0.6.0.dist-info → djresttoolkit-0.6.2.dist-info}/RECORD

@@ -1,21 +1,21 @@
 LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-README.md,sha256=mgYuT5MNL2ZmWzXLyU3VN0FA0sgyRM85Xn5EKxOM0Bs,5562
+README.md,sha256=q-R5E_ZZPZt6vLW4TL-HA8M601_vQrI53IZ-dIAgD9E,6983
 demo/staticfiles/admin/img/LICENSE,sha256=0RT6_zSIwWwxmzI13EH5AjnT1j2YU3MwM9j3U19cAAQ,1081
 src/djresttoolkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/djresttoolkit/admin.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/djresttoolkit/apps.py,sha256=nKb5GUIEhAB3IL3lTmEXNc5XuvvaZupH-1CCuYKFrEQ,158
 src/djresttoolkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/djresttoolkit/dbseed/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/djresttoolkit/dbseed/models/__init__.py,sha256=SpAEE8mfd_cX8qgI-CeC4r1e17YLAwAlxeFgbK8gtE4,118
-src/djresttoolkit/dbseed/models/_base_seed_model.py,sha256=DlbmdafLicKd_ja1AIvKKzyBxdnxdq23zPJwlqxiTl8,2187
+src/djresttoolkit/dbseed/models/__init__.py,sha256=B2WJqw2ncqf5nNhkM3XDFx13oNg2ccsULUQkFAjOyrY,105
 src/djresttoolkit/dbseed/models/_gen.py,sha256=qBPQaLvh1rcEam0YmE4JBJqpa-Vv5IFlIIagkEMHDVw,206
+src/djresttoolkit/dbseed/models/_seed_model.py,sha256=0cmbi0VNKjmJbwhjeCFsvb3iKYjok6TJOk6Y2MF_3N4,2443
 src/djresttoolkit/mail/__init__.py,sha256=tB9SdMlhfWQ640q4aobZ0H1c7fTWalpDL2I-onkr2VI,268
 src/djresttoolkit/mail/_email_sender.py,sha256=bPMqgD5HibJcOZgO6xxHOhdK9HEhnGNC6BoMPpo-h7k,3096
 src/djresttoolkit/mail/_models.py,sha256=of5KsLGvsN2OWgDYgdtLEijulg817TXgsLKuUdsnDQc,1447
 src/djresttoolkit/mail/_types.py,sha256=zf6CcXR1ei_UmZ1nLAJa378OAJ6ftnBICqEOkzXPNw8,646
 src/djresttoolkit/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/djresttoolkit/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/djresttoolkit/management/commands/dbseed.py,sha256=tMpvvDx_es08GxYKgJ1umJddh_kmIB1Fy0J5Ich2hiE,4248
+src/djresttoolkit/management/commands/dbseed.py,sha256=sY87TvvzECG7aQXxsDjr45VzCzJpofLacBK49EYFK8M,4225
 src/djresttoolkit/middlewares/__init__.py,sha256=GZHU3Yy4xXoEi62tHn0UJNxN6XgGM2_HES8Bt5AS5Lk,100
 src/djresttoolkit/middlewares/_response_time_middleware.py,sha256=1wCwdkW5Ng6HJo8zx0F7ylms84OGP-1K0kbyG6Vacuk,908
 src/djresttoolkit/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -27,8 +27,8 @@ src/djresttoolkit/throttling/_throttle_inspector.py,sha256=Kss6ZxKy-EXq9UGaGprGD
 src/djresttoolkit/views/__init__.py,sha256=XrxBrs6sH4HmUzp41omcmy_y94pSaXAVn01ttQ022-4,76
 src/djresttoolkit/views/_exceptions/__init__.py,sha256=DrCUxuPNyBR4WhzNutn5HDxLa--q51ykIxSG7_bFsOI,83
 src/djresttoolkit/views/_exceptions/_exception_handler.py,sha256=_o7If47bzWLl57LeSXSWsIDsJGo2RIpwYAwNQ-hsHVY,2839
-djresttoolkit-0.6.0.dist-info/METADATA,sha256=KKviIBCDtQeoaRNcs8w5zZvlTNVyK1KJXwqNo7hcogM,8501
-djresttoolkit-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-djresttoolkit-0.6.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
-djresttoolkit-0.6.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-djresttoolkit-0.6.0.dist-info/RECORD,,
+djresttoolkit-0.6.2.dist-info/METADATA,sha256=oeLct3kUn0oN2t0SYWXTp-XYRURhNaAcHi7srpU9mE4,9922
+djresttoolkit-0.6.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+djresttoolkit-0.6.2.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
+djresttoolkit-0.6.2.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
+djresttoolkit-0.6.2.dist-info/RECORD,,

src/djresttoolkit/dbseed/models/__init__.py

@@ -1,4 +1,4 @@
-from ._base_seed_model import BaseSeedModel
 from ._gen import Field, Gen
+from ._seed_model import SeedModel
 
-__all__ = ["BaseSeedModel", "Gen", "Field"]
+__all__ = ["SeedModel", "Gen", "Field"]

src/djresttoolkit/dbseed/models/{_base_seed_model.py → _seed_model.py}

@@ -1,31 +1,36 @@
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, ClassVar
 
 from django.db.models import ForeignKey, ManyToManyField, Model, OneToOneField
 from pydantic import BaseModel
 
 
-class BaseSeedModel(BaseModel):
+class SeedModel(BaseModel):
     """
     Base class for all fake data models.
-    Each subclass must define a `model` attribute.
+    Each subclass must define a `__model__` attribute (a Django model).
     """
 
-    class Meta:
-        model: type[Model]
+    __model__: ClassVar[type[Model] | None] = None
 
     def __init_subclass__(cls, **kwargs: Any) -> None:
         super().__init_subclass__(**kwargs)
-        if not hasattr(cls, "Meta") or not hasattr(cls.Meta, "model"):
+        if not hasattr(cls, "__model__"):
             raise TypeError(
-                f"{cls.__name__} must define a Meta class with a Django model"
+                f"{cls.__name__} must define a `__model__` attribute "
+                f"pointing to a Django model"
             )
 
     @classmethod
-    def get_meta(cls) -> type[Meta]:
-        """Class-level access."""
-        return cls.Meta
+    def get_model(cls) -> type[Model]:
+        """Class-level access to the Django model."""
+        if cls.__model__ is None:
+            raise ValueError(
+                f"{cls.__name__} has no `__model__` defined. "
+                "Please set it to a Django model class."
+            )
+        return cls.__model__
 
     @classmethod
     def create_instance(cls) -> tuple[dict[str, Any], list[ManyToManyField[Any, Any]]]:
@@ -35,13 +40,13 @@ class BaseSeedModel(BaseModel):
         data = cls().model_dump()
 
         # Handle ForeignKey and OneToOneField
-        for field in cls.get_meta().model._meta.get_fields():
+        for field in cls.get_model()._meta.get_fields():
             if isinstance(field, (ForeignKey, OneToOneField)):
                 rel_model = field.remote_field.model
                 if rel_model.objects.exists():
                     # For OneToOne, must ensure unique (pick unused relation)
                     if isinstance(field, OneToOneField):
-                        used_ids = cls.get_meta().model.objects.values_list(
+                        used_ids = cls.get_model().objects.values_list(
                             field.name, flat=True
                         )
                         available = rel_model.objects.exclude(pk__in=used_ids)
@@ -53,7 +58,8 @@ class BaseSeedModel(BaseModel):
         # Collect ManyToMany fields
         m2m_fields: list[ManyToManyField[Any, Any]] = [
             field
-            for field in cls.get_meta().model._meta.get_fields()
+            for field in cls.get_model()._meta.get_fields()
             if isinstance(field, ManyToManyField)
         ]
         return data, m2m_fields
+  

src/djresttoolkit/management/commands/dbseed.py

@@ -8,7 +8,7 @@ from django.core.management.base import BaseCommand, CommandParser
 from django.db import transaction
 from django.db.models import Model, QuerySet
 
-from djresttoolkit.dbseed.models import BaseSeedModel
+from djresttoolkit.dbseed.models import SeedModel
 
 
 class Command(BaseCommand):
@@ -48,7 +48,7 @@ class Command(BaseCommand):
             faker = Faker()
             faker.seed_instance(seed)
 
-        seed_model_classes: list[type[BaseSeedModel]] = []
+        seed_model_classes: list[type[SeedModel]] = []
 
         # Discover all dbseed dirs in installed apps
         for app_config in apps.get_app_configs():
@@ -67,14 +67,14 @@ class Command(BaseCommand):
                     attr = getattr(submodule, attr_name)
                     if (
                         isinstance(attr, type)
-                        and issubclass(attr, BaseSeedModel)
-                        and attr is not BaseSeedModel
+                        and issubclass(attr, SeedModel)
+                        and attr is not SeedModel
                     ):
                         # Filter by model name if provided
                         if (
                             not model_name
                             or model_name.lower()
-                            == attr.__name__.replace("DBSeedModel", "").lower()
+                            == attr.__name__.replace("SeedModel", "").lower()
                         ):
                             seed_model_classes.append(attr)
 
@@ -84,7 +84,7 @@ class Command(BaseCommand):
 
         # Generate fake data for each discovered dbseed model
         for dbseed_cls in seed_model_classes:
-            django_model = dbseed_cls.get_meta().model
+            django_model = dbseed_cls.get_model()
             created_count: int = 0
 
             for _ in range(count):