django-drfkit 0.1.0__py3-none-any.whl

django_drfkit-0.1.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: django-drfkit
+Version: 0.1.0
+Summary: A CLI tool for production-ready DRF scaffolding
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: typer
+Requires-Dist: jinja2
+
+# DRFKit
+
+A powerful CLI tool for scaffolding Django REST Framework projects with a clean, production-ready architecture.
+
+
+
+## Features
+
+* **Instant Scaffolding:** Creates a scalable folder structure with `apps/` and `config/` directories.
+* **Security First:** Auto-generates a cryptographically secure `SECRET_KEY` during creation.
+* **Split Settings:** Pre-configured `base.py`, `dev.py`, and `prod.py` for better environment management.
+* **DRF Ready:** Django REST Framework is installed and added to installed apps by default.
+* **Clean Templates:** Generates `.env` and requirements files automatically.
+
+## Installation
+
+Install the package via pip:
+
+```bash
+pip install drfkit
+```
+
+*(Requires Python 3.8+)*
+
+## Quick Start
+
+### 1. Create a New Project
+
+Run the following command to scaffold your project:
+
+```bash
+drfkit new project myproject
+```
+
+This creates the following structure:
+
+```text
+myproject/
+├── config/
+│   ├── settings/
+│   │   ├── base.py
+│   │   ├── dev.py
+│   │   └── prod.py
+│   ├── urls.py
+│   ├── wsgi.py
+│   └── asgi.py
+├── apps/                  # Your apps go here
+├── requirements/
+│   └── base.txt
+├── .env                   # Pre-filled with your secret key
+└── manage.py
+```
+
+### 2. Run the Server
+
+Navigate to your project and start the development server:
+
+```bash
+cd myproject
+python -m venv venv
+source venv/bin/activate  
+pip install -r requirements/base.txt
+python manage.py runserver
+```
+
+No extra configuration needed—it works out of the box!
+
+## Usage
+
+### Creating an App
+
+DRFKit encourages a modular structure by placing apps inside the `apps/` directory.
+
+```bash
+drfkit new app myapp
+```
+
+This generates:
+
+```text
+apps/myapp/
+├── __init__.py
+├── admin.py
+├── apps.py
+├── models.py
+├── serializers.py    # Ready for DRF
+├── tests.py
+├── urls.py
+└── views.py
+```
+
+> **Note:** Remember to add `'apps.myapp'` to `INSTALLED_APPS` in `config/settings/base.py`.
+
+## Configuration
+
+### Environment Settings
+
+* **Development:** By default, `manage.py` uses `config.settings.dev`. This is perfect for local coding.
+* **Production:** To switch to production settings, set the environment variable:
+  ```bash
+  export DJANGO_SETTINGS_MODULE=config.settings.prod
+  ```
+
+### Secret Key
+
+A unique `SECRET_KEY` is generated and placed inside `settings/base.py` automatically when you create a project. This ensures your local development is secure from the start.
+
+## Contributing
+
+Contributions are welcome! If you have ideas for improvement or find a bug, feel free to open an issue or submit a pull request.
+
+## 👤 Author
+
+**[Your Name]**
+* GitHub: [[Oviyan](https://github.com/Oviyan007/)]
+* Linkedin: [[Oviyan](https://www.linkedin.com/in/oviyan-s/)]

django_drfkit-0.1.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+drfkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+drfkit/cli.py,sha256=INYFxTanTapYSwp-41yhZkpwYNp1K0i65RClXYA5_kM,284
+drfkit/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+drfkit/commands/app.py,sha256=5nqTrEo584hvxm3y2ThnkF1xWCP9TLF0IKL0sBU6s2w,254
+drfkit/commands/new.py,sha256=CnZewHBCXsZb-oAVGCF8vXeSP66bc0Y2p2FzCtzekCc,3942
+drfkit/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+drfkit/core/renderer.py,sha256=s_7I1dkIPXz8nt8lbcKBgxy6QuPEp37-K5LE85Uep9k,648
+drfkit/templates/app/__init__.py.j2,sha256=rQnHgFRsn-6y3yS_AXU5885xoQqB0TepUqCHnx4q9-g,79
+drfkit/templates/app/admin.py.j2,sha256=yZDOS7tlghDMcAu6A4UJoLX-fRd04iV1hkmTjAj0yZI,240
+drfkit/templates/app/apps.py.j2,sha256=xs3u_vhqyKcd5xU9u39JaWmL4tIzHd4J-NVCFDJXO0Y,178
+drfkit/templates/app/models.py.j2,sha256=hPlMx-cG1oXfyB4ubH-nJOP_fp0wvtFN8_z8Vj8M8gw,58
+drfkit/templates/app/serializers.py.j2,sha256=hQ4xI__4BqlrvcO3Pj2JQLd8oDcRD35WK3RRIIqbqYw,70
+drfkit/templates/app/tests.py.j2,sha256=Fr0r-qWlGT2-ZiB69i1rFX1V-IPCPzLzRBA7z5u3xQY,61
+drfkit/templates/app/urls.py.j2,sha256=BHvQjr0g_a6dHCpDprDlHSj_NZGS8_vPJjsbtAxdsj0,304
+drfkit/templates/app/views.py.j2,sha256=Yn-dwHFEkxaRK-bVuKSsKeH9_PtVCloHiYxt4ycNuE0,326
+drfkit/templates/project/asgi.py.j2,sha256=eq8XfXfI0ljsnU2tqiqGMLNzlw9HBeGpzS34cdfCb6s,175
+drfkit/templates/project/env.j2,sha256=uLJjpnxs_1eTrE9882qAm24YjEPyGd2n2enJe25snaI,87
+drfkit/templates/project/manage.py.j2,sha256=0AFA81IVWAUYaHex6OlWymjj1oZiFLXz7_46vst-9t4,261
+drfkit/templates/project/urls.py.j2,sha256=VXKHD07dxVfNc6ahE8-hvwItsWeV22wpNJnr1gjnT2c,210
+drfkit/templates/project/wsgi.py.j2,sha256=c9Vy6vYmL657Jso-qvd6TfJkXJOX4juIuhydt9w-vbc,175
+drfkit/templates/project/requirements/base.txt.j2,sha256=sNq-iGbbaW-RnnWLDUtt17xZdcGmxvJLM2vDNT1t1-Q,53
+drfkit/templates/project/settings/__init__.py.j2,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+drfkit/templates/project/settings/base.py.j2,sha256=perECpjwyI_okFCeHmGuJsZaoYB1KY8hItqxhTJTT6w,1985
+drfkit/templates/project/settings/dev.py.j2,sha256=wVMV6nDmlWuQaKDoQRxgiEdOKrCtLpPUtsmYk1baDuI,55
+drfkit/templates/project/settings/prod.py.j2,sha256=7th7ZgG_NV2NuZKCGYu9iZWjZH2h1I82twEXnxTfDgY,56
+drfkit/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+drfkit/utils/template.py,sha256=Gz_yL72gu4ofec1H2yS8AQ28si1UobHndInKdUEBxwU,483
+django_drfkit-0.1.0.dist-info/METADATA,sha256=14IRMz-Tfc-eOWmkoKe2pqWXzlOJLMZfTn6GLI1Vrjs,3190
+django_drfkit-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+django_drfkit-0.1.0.dist-info/entry_points.txt,sha256=F0VpvMcgitF_-AXaMsiN2fq0JTDc51WlC__bmipV8TA,42
+django_drfkit-0.1.0.dist-info/top_level.txt,sha256=KC8RxM3aOEmOemRFr04GNggBa8F-uMBfngJJgfIsqN8,7
+django_drfkit-0.1.0.dist-info/RECORD,,

django_drfkit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_drfkit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+drfkit = drfkit.cli:cli

django_drfkit-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+drfkit

drfkit/cli.py

@@ -0,0 +1,10 @@
+import typer
+from drfkit.commands import new
+
+cli = typer.Typer(name="drfkit", help="A CLI tool for scaffolding DRF projects")
+
+# Register the 'new' group which contains 'project' and 'app' commands
+cli.add_typer(new.app_cmd, name="new")
+
+if __name__ == "__main__":
+    cli()

drfkit/commands/app.py

@@ -0,0 +1,7 @@
+import typer
+
+app = typer.Typer()
+
+@app.command()
+def create():
+    print("Create app")                                                                                                                                                                 

drfkit/commands/new.py

@@ -0,0 +1,102 @@
+import typer
+import secrets
+import string
+from pathlib import Path
+from drfkit.utils.template import render
+
+app_cmd= typer.Typer(help="Create new DRF projects or apps")
+
+def generate_secret_key(length=50):
+    """Generate a cryptographically secure random string."""
+    chars = string.ascii_letters + string.digits + string.punctuation
+    # Ensure we don't use characters that might break .env files or Python strings easily (optional)
+    # For simplicity, we just pick from the standard set:
+    return ''.join(secrets.choice(chars) for _ in range(length))
+@app_cmd.command()
+def project(name: str):
+    """
+    Scaffold a new DRF project with split settings and clean structure.
+    """
+    root = Path(name)
+    
+    if root.exists():
+        typer.secho(f"Error: Directory '{name}' already exists.", fg=typer.colors.RED)
+        raise typer.Exit(1)
+    # Generate the key here
+    secret_key = generate_secret_key()
+    context = {"project_name": name,"secret_key": secret_key}
+
+    # Define folder structure
+    dirs = [
+        root / "config" / "settings",
+        root / "apps",
+        root / "scripts",
+        root / "requirements"
+    ]
+
+    for d in dirs:
+        d.mkdir(parents=True, exist_ok=True)
+
+    # Create __init__.py for python packages
+    (root / "apps").joinpath("__init__.py").touch()
+    (root / "config").joinpath("__init__.py").touch()
+
+    # Define files to render
+    files = {
+        "project/manage.py.j2": root / "manage.py",
+        "project/urls.py.j2": root / "config" / "urls.py",
+        "project/wsgi.py.j2": root / "config" / "wsgi.py",
+        "project/asgi.py.j2": root / "config" / "asgi.py",
+        "project/settings/base.py.j2": root / "config" / "settings" / "base.py",
+        "project/settings/dev.py.j2": root / "config" / "settings" / "dev.py",
+        "project/settings/prod.py.j2": root / "config" / "settings" / "prod.py",
+        "project/settings/__init__.py.j2": root / "config" / "settings" / "__init__.py",
+        "project/env.j2": root / ".env",
+        "project/requirements/base.txt.j2": root / "requirements" / "base.txt",
+    }
+
+    with typer.progressbar(files.items(), label="Generating files") as progress_bar:
+        for template, dest in progress_bar:
+            render(template, dest, context)
+
+    typer.secho(f"\n✔ Project '{name}' created successfully!", fg=typer.colors.GREEN)
+    typer.echo(f"  cd {name}")
+    typer.echo(f"  python -m venv venv &&  venv/bin/activate")
+    typer.echo(f"  pip install -r requirements/base.txt")
+
+@app_cmd.command()
+def app(name: str):
+    """
+    Scaffold a new DRF app inside the 'apps/' directory.
+    """
+    # We assume this command is run inside a drfkit-generated project root
+    app_dir = Path("apps") / name
+
+    if app_dir.exists():
+        typer.secho(f"Error: App '{name}' already exists in apps/.", fg=typer.colors.RED)
+        raise typer.Exit(1)
+    
+    if not Path("apps").exists():
+        typer.secho("Error: 'apps' directory not found. Are you in a drfkit project root?", fg=typer.colors.RED)
+        raise typer.Exit(1)
+
+    app_dir.mkdir(parents=True, exist_ok=True)
+    
+    context = {"app_name": name}
+
+    files = {
+        "app/models.py.j2": app_dir / "models.py",
+        "app/serializers.py.j2": app_dir / "serializers.py",
+        "app/views.py.j2": app_dir / "views.py",
+        "app/urls.py.j2": app_dir / "urls.py",
+        "app/tests.py.j2": app_dir / "tests.py",
+        "app/admin.py.j2": app_dir / "admin.py",
+        "app/apps.py.j2": app_dir / "apps.py",
+        "app/__init__.py.j2": app_dir / "__init__.py",
+    }
+
+    for template, dest in files.items():
+        render(template, dest, context)
+
+    typer.secho(f"✔ App '{name}' created at apps/{name}", fg=typer.colors.GREEN)
+    typer.echo(f"  Don't forget to add 'apps.{name}' to INSTALLED_APPS in config/settings/base.py")

drfkit/core/renderer.py

@@ -0,0 +1,21 @@
+import os
+from jinja2 import Environment, FileSystemLoader
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+TEMPLATE_DIR = os.path.join(BASE_DIR, "templates")
+
+env = Environment(loader=FileSystemLoader(TEMPLATE_DIR))
+
+
+def render_project(project_name: str):
+    context = {"project_name": project_name}
+
+    os.makedirs(project_name, exist_ok=True)
+
+    template = env.get_template("project/manage.py.j2")
+    content = template.render(context)
+
+    with open(os.path.join(project_name, "manage.py"), "w") as f:
+        f.write(content)
+
+    print(f"✔ Project '{project_name}' created")

drfkit/templates/app/__init__.py.j2

@@ -0,0 +1 @@
+default_app_config = 'apps.{{ app_name }}.apps.{{ app_name|capitalize }}Config'

drfkit/templates/app/admin.py.j2

@@ -0,0 +1,6 @@
+from django.contrib import admin
+from .models import {{ app_name|capitalize }}
+
+@admin.register({{ app_name|capitalize }})
+class {{ app_name|capitalize }}Admin(admin.ModelAdmin):
+    list_display = ('id',)  # Add your model fields here

drfkit/templates/app/apps.py.j2

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+class {{ app_name|capitalize }}Config(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'apps.{{ app_name }}'

drfkit/templates/app/models.py.j2

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

drfkit/templates/app/serializers.py.j2

@@ -0,0 +1,3 @@
+from rest_framework import serializers
+
+# Add your serializers here.

drfkit/templates/app/tests.py.j2

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

drfkit/templates/app/urls.py.j2

@@ -0,0 +1,10 @@
+from django.urls import path, include
+from rest_framework.routers import DefaultRouter
+from .views import {{ app_name|capitalize }}ViewSet
+
+router = DefaultRouter()
+router.register(r'{{ app_name|lower }}s', {{ app_name|capitalize }}ViewSet)
+
+urlpatterns = [
+    path('', include(router.urls)),
+]

drfkit/templates/app/views.py.j2

@@ -0,0 +1,7 @@
+from rest_framework import viewsets
+from .models import {{ app_name|capitalize }}
+from .serializers import {{ app_name|capitalize }}Serializer
+
+class {{ app_name|capitalize }}ViewSet(viewsets.ModelViewSet):
+    queryset = {{ app_name|capitalize }}.objects.all()
+    serializer_class = {{ app_name|capitalize }}Serializer

drfkit/templates/project/asgi.py.j2

@@ -0,0 +1,6 @@
+import os
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.prod')
+
+application = get_asgi_application()

drfkit/templates/project/env.j2

@@ -0,0 +1,3 @@
+DJANGO_SETTINGS_MODULE=config.settings.dev
+SECRET_KEY=your-secret-key-here
+DEBUG=True

drfkit/templates/project/manage.py.j2

@@ -0,0 +1,10 @@
+import os
+import sys
+
+def main():
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.dev')
+    from django.core.management import execute_from_command_line
+    execute_from_command_line(sys.argv)
+
+if __name__ == '__main__':
+    main()

drfkit/templates/project/requirements/base.txt.j2

@@ -0,0 +1,3 @@
+django>=4.0
+djangorestframework>=3.14
+python-dotenv

drfkit/templates/project/settings/base.py.j2

@@ -0,0 +1,66 @@
+from pathlib import Path
+
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
+
+SECRET_KEY = '{{secret_key}}'
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    
+    # Third party
+    'rest_framework',
+
+    # Local apps
+    # Add your apps here, e.g., 'apps.users'
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'config.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        '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',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'config.wsgi.application'
+
+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'},
+]
+
+LANGUAGE_CODE = 'en-us'
+TIME_ZONE = 'UTC'
+USE_I18N = True
+USE_TZ = True
+
+STATIC_URL = 'static/'
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

drfkit/templates/project/settings/dev.py.j2

@@ -0,0 +1,4 @@
+from .base import *
+
+DEBUG = True
+ALLOWED_HOSTS = []

drfkit/templates/project/settings/prod.py.j2

@@ -0,0 +1,4 @@
+from .base import *
+
+DEBUG = False
+ALLOWED_HOSTS = []

drfkit/templates/project/urls.py.j2

@@ -0,0 +1,8 @@
+from django.contrib import admin
+from django.urls import path, include
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    # Add your API urls here
+    # path('api/', include('apps.users.urls')),
+]

drfkit/templates/project/wsgi.py.j2

@@ -0,0 +1,6 @@
+import os
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.prod')
+
+application = get_wsgi_application()

drfkit/utils/template.py

@@ -0,0 +1,14 @@
+from jinja2 import Environment, FileSystemLoader
+from pathlib import Path
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+TEMPLATE_DIR = BASE_DIR / "templates"
+
+env = Environment(loader=FileSystemLoader(TEMPLATE_DIR))
+
+def render(template_path: str, destination: Path, context: dict):
+    template = env.get_template(template_path)
+    content = template.render(**context)
+
+    destination.parent.mkdir(parents=True, exist_ok=True)
+    destination.write_text(content)