djresttoolkit 0.6.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

README.md

@@ -28,9 +28,124 @@ 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
+```
+
+Here’s a **concise API reference** for your database flush management command for `djresttoolkit`:
+
+---
+
+### 2. DB Flush Command
+
+```python
+from djresttoolkit.management.commands import flush
+```
+
+#### `manage.py dbflush`
+
+Command to **delete all records** from the database for all models or a specific model and **reset auto-increment IDs**.
+
+#### Usage
+
+```bash
+python manage.py flush [--model ModelName] [--yes]
+```
+
+#### dbflush command options
+
+- `--model`: Name of the model to flush (case-sensitive, e.g., `User`). If omitted, flushes all models.
+- `--yes`: Skip confirmation prompt. Without this, the command asks for confirmation before deleting.
+
+#### dbflush command behavior
+
+- Deletes all records for the specified model or all models.
+- Resets primary key sequences for supported databases:
+
+  - PostgreSQL: `ALTER SEQUENCE ... RESTART WITH 1`
+  - SQLite: Deletes from `sqlite_sequence` table
+  - Others: Logs a warning (not implemented).
+- Uses transactions to ensure safe operations.
+
+#### dbflush command example
+
+```bash
+# Flush all models with confirmation
+python manage.py dbflush
+
+# Flush a specific model (User) with confirmation
+python manage.py dbflush --model User
+
+# Flush all models without prompt
+python manage.py dbflush --yes
+```
+
+#### Output
+
+```bash
+Flushed 10 records from model "User" and reset IDs.
+```
+
+or
+
+```bash
+Flushed 120 records from all models and reset IDs.
+```
+
+### 3. EmailSender
 
 ```python
 from djresttoolkit.mail import EmailSender, EmailContent, EmailTemplate
@@ -56,7 +171,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 +194,7 @@ EmailSender(content).send(to=["user@example.com"])
 
 - `text`, `html` — template file paths
 
-### 2. Custom DRF Exception Handler
+### 4. Custom DRF Exception Handler
 
 ```python
 from djresttoolkit.views import exception_handler
@@ -119,7 +234,7 @@ REST_FRAMEWORK = {
 - Tracks requests in cache and calculates `retry_after`.
 - Cleans expired timestamps automatically.
 
-### 3. Response Time Middleware
+### 5. Response Time Middleware
 
 ```python
 from djresttoolkit.middlewares import ResponseTimeMiddleware
@@ -137,7 +252,7 @@ ResponseTimeMiddleware(get_response: Callable[[HttpRequest], HttpResponse])
 
 - `get_response`: The next middleware or view callable.
 
-#### Usage
+#### Response Time Middleware Usage
 
 Add it to your Django `MIDDLEWARE` in `settings.py`:
 
@@ -148,7 +263,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 +281,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 4. Throttle Utilities
+### 6. Throttle Utilities
 
 #### `ThrottleInfoJSONRenderer`
 

{djresttoolkit-0.6.1.dist-info → djresttoolkit-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.6.1
+Version: 0.7.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
@@ -84,9 +84,124 @@ 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
+```
+
+Here’s a **concise API reference** for your database flush management command for `djresttoolkit`:
+
+---
+
+### 2. DB Flush Command
+
+```python
+from djresttoolkit.management.commands import flush
+```
+
+#### `manage.py dbflush`
+
+Command to **delete all records** from the database for all models or a specific model and **reset auto-increment IDs**.
+
+#### Usage
+
+```bash
+python manage.py flush [--model ModelName] [--yes]
+```
+
+#### dbflush command options
+
+- `--model`: Name of the model to flush (case-sensitive, e.g., `User`). If omitted, flushes all models.
+- `--yes`: Skip confirmation prompt. Without this, the command asks for confirmation before deleting.
+
+#### dbflush command behavior
+
+- Deletes all records for the specified model or all models.
+- Resets primary key sequences for supported databases:
+
+  - PostgreSQL: `ALTER SEQUENCE ... RESTART WITH 1`
+  - SQLite: Deletes from `sqlite_sequence` table
+  - Others: Logs a warning (not implemented).
+- Uses transactions to ensure safe operations.
+
+#### dbflush command example
+
+```bash
+# Flush all models with confirmation
+python manage.py dbflush
+
+# Flush a specific model (User) with confirmation
+python manage.py dbflush --model User
+
+# Flush all models without prompt
+python manage.py dbflush --yes
+```
+
+#### Output
+
+```bash
+Flushed 10 records from model "User" and reset IDs.
+```
+
+or
+
+```bash
+Flushed 120 records from all models and reset IDs.
+```
+
+### 3. EmailSender
 
 ```python
 from djresttoolkit.mail import EmailSender, EmailContent, EmailTemplate
@@ -112,7 +227,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 +250,7 @@ EmailSender(content).send(to=["user@example.com"])
 
 - `text`, `html` — template file paths
 
-### 2. Custom DRF Exception Handler
+### 4. Custom DRF Exception Handler
 
 ```python
 from djresttoolkit.views import exception_handler
@@ -175,7 +290,7 @@ REST_FRAMEWORK = {
 - Tracks requests in cache and calculates `retry_after`.
 - Cleans expired timestamps automatically.
 
-### 3. Response Time Middleware
+### 5. Response Time Middleware
 
 ```python
 from djresttoolkit.middlewares import ResponseTimeMiddleware
@@ -193,7 +308,7 @@ ResponseTimeMiddleware(get_response: Callable[[HttpRequest], HttpResponse])
 
 - `get_response`: The next middleware or view callable.
 
-#### Usage
+#### Response Time Middleware Usage
 
 Add it to your Django `MIDDLEWARE` in `settings.py`:
 
@@ -204,7 +319,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 +337,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 4. Throttle Utilities
+### 6. Throttle Utilities
 
 #### `ThrottleInfoJSONRenderer`
 

{djresttoolkit-0.6.1.dist-info → djresttoolkit-0.7.0.dist-info}/RECORD

@@ -1,12 +1,13 @@
 LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-README.md,sha256=mgYuT5MNL2ZmWzXLyU3VN0FA0sgyRM85Xn5EKxOM0Bs,5562
+README.md,sha256=5bxE-TuyTrqyyWh3iISPe0GtLYyU7bOuCEdooPj_DQo,8418
 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=B2WJqw2ncqf5nNhkM3XDFx13oNg2ccsULUQkFAjOyrY,105
+src/djresttoolkit/dbseed/models/__init__.py,sha256=uuynQIcfVqEaZN9hF_caI24zm8az23JdXLDrv7xOKTQ,180
+src/djresttoolkit/dbseed/models/_choice_field.py,sha256=T7LAzbyXqlYp2mtCAKL8E1Da_MEh9RzgLZrFJ7fa4gM,446
 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
@@ -15,7 +16,8 @@ src/djresttoolkit/mail/_models.py,sha256=of5KsLGvsN2OWgDYgdtLEijulg817TXgsLKuUds
 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=vS-s_B8No2rTl_T7HuIBg7f_Yp_6lztvK7FbcaxTZaA,4227
+src/djresttoolkit/management/commands/dbflush.py,sha256=v7rXcuNQDiXLV7p0xzKMNXVeWAN7QKmq2qQQAbhHEEw,3423
+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 +29,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.1.dist-info/METADATA,sha256=doM3qba2_MGPAyrrfz3g79IjcNGaKyqiXYodOYFotso,8501
-djresttoolkit-0.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-djresttoolkit-0.6.1.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
-djresttoolkit-0.6.1.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-djresttoolkit-0.6.1.dist-info/RECORD,,
+djresttoolkit-0.7.0.dist-info/METADATA,sha256=k3gElJabHxN1l_dkMK0eld3Gt1W6QWofd2eyjT1-F_4,11357
+djresttoolkit-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+djresttoolkit-0.7.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
+djresttoolkit-0.7.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
+djresttoolkit-0.7.0.dist-info/RECORD,,

src/djresttoolkit/dbseed/models/__init__.py

@@ -1,4 +1,10 @@
 from ._gen import Field, Gen
 from ._seed_model import SeedModel
+from ._choice_field import choice_field
 
-__all__ = ["SeedModel", "Gen", "Field"]
+__all__ = [
+    "SeedModel",
+    "Gen",
+    "Field",
+    "choice_field",
+]

src/djresttoolkit/dbseed/models/_choice_field.py

@@ -0,0 +1,17 @@
+import random
+
+from pydantic import Field
+
+
+def choice_field[T](choices: list[T]) -> T:
+    """
+    Creates a field with a default value randomly selected from the provided choices.
+    Args:
+        choices (list[T]): A list of possible values for the field.
+    Returns:
+        T: A field with a default value randomly chosen from the given choices.
+    """
+
+    return Field(
+        default_factory=lambda: random.choice(seq=choices),
+    )

src/djresttoolkit/management/commands/dbflush.py

@@ -0,0 +1,94 @@
+from typing import Any
+
+from django.apps import apps
+from django.core.management.base import BaseCommand, CommandError, CommandParser
+from django.db import connection, transaction
+
+
+class Command(BaseCommand):
+    help = "Flush database records for all models or a specific model"
+
+    def add_arguments(self, parser: CommandParser) -> None:
+        parser.add_argument(
+            "--model",
+            type=str,
+            help="Specify the model name to flush records (case-sensitive, e.g., User)",
+        )
+        parser.add_argument(
+            "--yes",
+            action="store_true",
+            help="Confirm flush without prompt",
+        )
+
+    def handle(self, *args: Any, **options: Any) -> None:
+        """Handle the flushing of database records and reset IDs."""
+
+        model_name = options.get("model")
+        confirm = options.get("yes", False)
+
+        if not confirm:
+            prompt = "Are you sure you want to flush "
+            prompt += f"the model '{model_name}'" if model_name else "all models"
+            prompt += "? [y/n]: "
+            user_input = input(prompt)
+            if user_input.lower() not in ["y", "yes"]:
+                self.stdout.write(self.style.WARNING("Operation cancelled."))
+                return
+
+        def reset_sequence(table_name: str) -> None:
+            """Reset auto-increment ID sequence for supported databases."""
+            with connection.cursor() as cursor:
+                if connection.vendor == "postgresql":
+                    cursor.execute(
+                        f'ALTER SEQUENCE "{table_name}_id_seq" RESTART WITH 1;'
+                    )
+                elif connection.vendor == "sqlite":
+                    cursor.execute(
+                        f"DELETE FROM sqlite_sequence WHERE name='{table_name}';"
+                    )
+                else:
+                    self.stdout.write(
+                        self.style.WARNING(
+                            f"ID reset not implemented for {connection.vendor}."
+                        )
+                    )
+
+        if model_name:
+            # Find the model automatically across all apps
+            model = None
+            for m in apps.get_models():
+                if m.__name__ == model_name:
+                    model = m
+                    break
+
+            if not model:
+                raise CommandError(
+                    f'Model "{model_name}" not found in any installed app.'
+                )
+
+            table_name = model._meta.db_table
+            with transaction.atomic():
+                deleted_count, _ = model.objects.all().delete()
+                reset_sequence(table_name)
+
+            self.stdout.write(
+                self.style.SUCCESS(
+                    f'Flushed {deleted_count} records from model "{model_name}" and reset IDs.'
+                )
+            )
+
+        else:
+            # Flush all models
+            total_deleted = 0
+            with transaction.atomic():
+                for model in apps.get_models():
+                    table_name = model._meta.db_table
+                    deleted_count, _ = model.objects.all().delete()
+                    total_deleted += deleted_count
+                    reset_sequence(table_name)
+
+            self.stdout.write(
+                self.style.SUCCESS(
+                    f"Flushed {total_deleted} records from all models and reset IDs."
+                )
+            )

src/djresttoolkit/management/commands/dbseed.py

@@ -74,7 +74,7 @@ class Command(BaseCommand):
                         if (
                             not model_name
                             or model_name.lower()
-                            == attr.__name__.replace("DBSeedModel", "").lower()
+                            == attr.__name__.replace("SeedModel", "").lower()
                         ):
                             seed_model_classes.append(attr)