djboost 0.1.0__tar.gz

djboost-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 munjurdev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

djboost-0.1.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: djboost
+Version: 0.1.0
+Summary: Django project generator CLI — production-ready Django projects in one command
+Author: Munjur Alom
+License: MIT
+Project-URL: Homepage, https://github.com/munjurdev/djboost
+Project-URL: Repository, https://github.com/munjurdev/djboost
+Project-URL: Bug Tracker, https://github.com/munjurdev/djboost/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Dynamic: license-file
+
+# djboost 🚀
+
+`djboost` is a CLI tool that generates a fully-configured, production-ready Django project in one command. No more repetitive boilerplate setup.
+
+With a single command you get Django REST Framework, JWT Authentication, Celery, Redis, WebSockets (Channels), Docker, Swagger docs, and more — all pre-wired and ready to go.
+
+## ✨ Features
+
+- **API Ready** — Django REST Framework + Simple JWT pre-configured
+- **API Docs** — Auto-generated Swagger UI and ReDoc via `drf-spectacular`
+- **Async Tasks** — Celery + Redis integrated out of the box
+- **WebSockets** — Django Channels with Daphne and Redis channel layers
+- **Environment Variables** — `python-decouple` with a generated `.env` file
+- **Database** — Pre-configured for PostgreSQL (SQLite default for dev)
+- **CORS & Security** — `django-cors-headers` + standard security headers
+- **Docker** — Ready-to-use `Dockerfile` and `docker-compose.yml`
+- **Static Files** — Whitenoise configured for efficient static file serving
+- **Code Quality** — `pre-commit` with `black`, `flake8`, and `isort`
+- **Testing** — `pytest` + `pytest-django` with coverage pre-configured
+- **CI/CD** — Modular GitHub Actions and GitLab CI pipelines
+- **Custom Exception Handling** — Global DRF exception handler included
+
+---
+
+## � Installation
+
+```bash
+pip install djboost
+```
+
+---
+
+## 🚀 Quick Start
+
+### Step 1 — Create a virtual environment and activate it
+
+```bash
+python -m venv env
+
+# Windows
+env\Scripts\activate
+
+# Mac / Linux
+source env/bin/activate
+```
+
+### Step 2 — Install djboost
+
+```bash
+pip install djboost
+```
+
+### Step 3 — Navigate to an empty folder and create your project
+
+```bash
+# Create a project with a custom name
+djboost create project myproject
+
+# Or use the default name 'core'
+djboost create project
+```
+
+This single command will automatically:
+
+1. Install Django and run `startproject`
+2. Update `settings.py` with all advanced configurations
+3. Generate `.env`, `Dockerfile`, `docker-compose.yml`, and `.gitignore`
+4. Generate `pytest.ini` and `.pre-commit-config.yaml`
+5. Create `/apps`, `/static`, and `/media` directories
+6. Install all required dependencies
+7. Initialize a `git` repository and set up `pre-commit` hooks
+8. Freeze dependencies into `requirements.txt`
+
+---
+
+## 🧱 Creating Apps
+
+Apps are created inside the `apps/` directory to keep your project root clean. Settings and URLs are auto-configured.
+
+```bash
+# Navigate to your project root first
+cd myproject
+
+# Create a new app
+djboost create app users
+```
+
+This will:
+- Create `apps/users/` with standard Django app structure
+- Auto-add `'apps.users'` to `INSTALLED_APPS`
+- Auto-map `api/users/` in `urls.py`
+- Create a starter `urls.py` inside the app
+
+---
+
+## � Managing CI/CD Pipelines
+
+CI/CD is modular — add or remove it any time after project creation.
+
+### Add a pipeline
+
+```bash
+djboost add cicd github   # GitHub Actions
+djboost add cicd gitlab   # GitLab CI
+```
+
+### Remove a pipeline
+
+```bash
+djboost remove cicd github
+djboost remove cicd gitlab
+```
+
+---
+
+## 🏃 Running Your Project
+
+### Locally
+
+```bash
+# Apply migrations
+python manage.py migrate
+
+# Start the dev server
+python manage.py runserver
+```
+
+### API Documentation
+
+Once your server is running:
+
+| Interface | URL |
+|---|---|
+| Swagger UI | `http://127.0.0.1:8000/api/schema/swagger-ui/` |
+| ReDoc | `http://127.0.0.1:8000/api/schema/redoc/` |
+| OpenAPI Schema | `http://127.0.0.1:8000/api/schema/` |
+
+### Testing
+
+```bash
+pytest
+```
+
+### With Docker
+
+```bash
+docker-compose up --build
+```
+
+This spins up PostgreSQL, Redis, Celery worker, and a Daphne ASGI server together.
+
+---
+
+## ⚙️ CLI Reference
+
+```
+djboost --help
+djboost --version
+
+djboost create project [NAME]     Create a new Django project
+djboost create app NAME           Create a new app inside apps/
+
+djboost add cicd github|gitlab    Add a CI/CD pipeline
+djboost remove cicd github|gitlab Remove a CI/CD pipeline
+```
+
+---
+
+## 🐍 Requirements
+
+- Python 3.10+
+- Virtual environment (required — djboost will warn you if not activated)
+
+---
+
+## 📄 License
+
+MIT

djboost-0.1.0/README.md

@@ -0,0 +1,178 @@
+# djboost 🚀
+
+`djboost` is a CLI tool that generates a fully-configured, production-ready Django project in one command. No more repetitive boilerplate setup.
+
+With a single command you get Django REST Framework, JWT Authentication, Celery, Redis, WebSockets (Channels), Docker, Swagger docs, and more — all pre-wired and ready to go.
+
+## ✨ Features
+
+- **API Ready** — Django REST Framework + Simple JWT pre-configured
+- **API Docs** — Auto-generated Swagger UI and ReDoc via `drf-spectacular`
+- **Async Tasks** — Celery + Redis integrated out of the box
+- **WebSockets** — Django Channels with Daphne and Redis channel layers
+- **Environment Variables** — `python-decouple` with a generated `.env` file
+- **Database** — Pre-configured for PostgreSQL (SQLite default for dev)
+- **CORS & Security** — `django-cors-headers` + standard security headers
+- **Docker** — Ready-to-use `Dockerfile` and `docker-compose.yml`
+- **Static Files** — Whitenoise configured for efficient static file serving
+- **Code Quality** — `pre-commit` with `black`, `flake8`, and `isort`
+- **Testing** — `pytest` + `pytest-django` with coverage pre-configured
+- **CI/CD** — Modular GitHub Actions and GitLab CI pipelines
+- **Custom Exception Handling** — Global DRF exception handler included
+
+---
+
+## � Installation
+
+```bash
+pip install djboost
+```
+
+---
+
+## 🚀 Quick Start
+
+### Step 1 — Create a virtual environment and activate it
+
+```bash
+python -m venv env
+
+# Windows
+env\Scripts\activate
+
+# Mac / Linux
+source env/bin/activate
+```
+
+### Step 2 — Install djboost
+
+```bash
+pip install djboost
+```
+
+### Step 3 — Navigate to an empty folder and create your project
+
+```bash
+# Create a project with a custom name
+djboost create project myproject
+
+# Or use the default name 'core'
+djboost create project
+```
+
+This single command will automatically:
+
+1. Install Django and run `startproject`
+2. Update `settings.py` with all advanced configurations
+3. Generate `.env`, `Dockerfile`, `docker-compose.yml`, and `.gitignore`
+4. Generate `pytest.ini` and `.pre-commit-config.yaml`
+5. Create `/apps`, `/static`, and `/media` directories
+6. Install all required dependencies
+7. Initialize a `git` repository and set up `pre-commit` hooks
+8. Freeze dependencies into `requirements.txt`
+
+---
+
+## 🧱 Creating Apps
+
+Apps are created inside the `apps/` directory to keep your project root clean. Settings and URLs are auto-configured.
+
+```bash
+# Navigate to your project root first
+cd myproject
+
+# Create a new app
+djboost create app users
+```
+
+This will:
+- Create `apps/users/` with standard Django app structure
+- Auto-add `'apps.users'` to `INSTALLED_APPS`
+- Auto-map `api/users/` in `urls.py`
+- Create a starter `urls.py` inside the app
+
+---
+
+## � Managing CI/CD Pipelines
+
+CI/CD is modular — add or remove it any time after project creation.
+
+### Add a pipeline
+
+```bash
+djboost add cicd github   # GitHub Actions
+djboost add cicd gitlab   # GitLab CI
+```
+
+### Remove a pipeline
+
+```bash
+djboost remove cicd github
+djboost remove cicd gitlab
+```
+
+---
+
+## 🏃 Running Your Project
+
+### Locally
+
+```bash
+# Apply migrations
+python manage.py migrate
+
+# Start the dev server
+python manage.py runserver
+```
+
+### API Documentation
+
+Once your server is running:
+
+| Interface | URL |
+|---|---|
+| Swagger UI | `http://127.0.0.1:8000/api/schema/swagger-ui/` |
+| ReDoc | `http://127.0.0.1:8000/api/schema/redoc/` |
+| OpenAPI Schema | `http://127.0.0.1:8000/api/schema/` |
+
+### Testing
+
+```bash
+pytest
+```
+
+### With Docker
+
+```bash
+docker-compose up --build
+```
+
+This spins up PostgreSQL, Redis, Celery worker, and a Daphne ASGI server together.
+
+---
+
+## ⚙️ CLI Reference
+
+```
+djboost --help
+djboost --version
+
+djboost create project [NAME]     Create a new Django project
+djboost create app NAME           Create a new app inside apps/
+
+djboost add cicd github|gitlab    Add a CI/CD pipeline
+djboost remove cicd github|gitlab Remove a CI/CD pipeline
+```
+
+---
+
+## 🐍 Requirements
+
+- Python 3.10+
+- Virtual environment (required — djboost will warn you if not activated)
+
+---
+
+## 📄 License
+
+MIT

djboost-0.1.0/djboost/__init__.py

@@ -0,0 +1 @@
+# init

djboost-0.1.0/djboost/cli.py

@@ -0,0 +1,37 @@
+import typer
+from djboost.commands.create_project import create_project_command
+from djboost.commands.create_app import create_app_command
+from djboost.commands.add_cicd import add_cicd_command
+from djboost.commands.remove_cicd import remove_cicd_command
+
+app = typer.Typer(help="djboost — Django project generator CLI")
+create = typer.Typer(help="Create a new project or app")
+add = typer.Typer(help="Add integrations to your project")
+remove = typer.Typer(help="Remove integrations from your project")
+
+app.add_typer(create, name="create")
+app.add_typer(add, name="add")
+app.add_typer(remove, name="remove")
+
+create.command("project")(create_project_command)
+create.command("app")(create_app_command)
+add.command("cicd")(add_cicd_command)
+remove.command("cicd")(remove_cicd_command)
+
+
+def version_callback(value: bool):
+    if value:
+        typer.echo("djboost version 0.1.0")
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: bool = typer.Option(
+        None, "--version", "-v",
+        callback=version_callback,
+        is_eager=True,
+        help="Show the version and exit."
+    )
+):
+    pass

djboost-0.1.0/djboost/commands/__init__.py

@@ -0,0 +1 @@
+# init

djboost-0.1.0/djboost/commands/add_cicd.py

@@ -0,0 +1,16 @@
+import typer
+from rich import print
+from djboost.generator import generate_github_actions, generate_gitlab_ci, check_virtual_environment
+
+def add_cicd_command(provider: str = typer.Argument(..., help="The CI/CD provider to add (github or gitlab)")):
+    check_virtual_environment()
+    provider = provider.lower()
+    if provider == "github":
+        generate_github_actions()
+        print("[green]GitHub Actions workflow created successfully![/green]")
+    elif provider == "gitlab":
+        generate_gitlab_ci()
+        print("[green]GitLab CI pipeline created successfully![/green]")
+    else:
+        print(f"[red]Error: Unsupported provider '{provider}'. Supported providers are: github, gitlab.[/red]")
+        raise typer.Exit(code=1)

djboost-0.1.0/djboost/commands/create_app.py

@@ -0,0 +1,130 @@
+import re
+import sys
+import subprocess
+from pathlib import Path
+import typer
+from rich import print
+from djboost.generator import check_virtual_environment, validate_name
+
+
+def get_project_name():
+    if not Path("manage.py").exists():
+        print("[red]Error: manage.py not found. Are you in the project root?[/red]")
+        raise typer.Exit(1)
+
+    content = Path("manage.py").read_text(encoding="utf-8")
+    match = re.search(r"['\"]DJANGO_SETTINGS_MODULE['\"],\s*['\"]([^.]+)\.settings['\"]", content)
+    if match:
+        return match.group(1)
+
+    print("[red]Error: Could not determine project name from manage.py[/red]")
+    raise typer.Exit(1)
+
+
+def update_settings(project_name: str, app_name: str):
+    settings_path = Path(project_name) / "settings.py"
+    if not settings_path.exists():
+        print(f"[yellow]Warning: Could not find settings.py at {settings_path}. Skipping.[/yellow]")
+        return
+
+    content = settings_path.read_text(encoding="utf-8")
+    app_string = f"'apps.{app_name}',"
+
+    if app_string in content or f'"apps.{app_name}",' in content:
+        print(f"[yellow]App '{app_name}' is already in INSTALLED_APPS[/yellow]")
+        return
+
+    if "INSTALLED_APPS = [" in content:
+        content = re.sub(
+            r"(INSTALLED_APPS\s*=\s*\[.*?)(\n?\])",
+            rf"\1\n    {app_string}\2",
+            content,
+            flags=re.DOTALL
+        )
+        settings_path.write_text(content, encoding="utf-8")
+        print(f"[green]✔ Added '{app_string}' to INSTALLED_APPS[/green]")
+    else:
+        print("[yellow]Warning: Could not find INSTALLED_APPS in settings.py[/yellow]")
+
+
+def update_urls(project_name: str, app_name: str):
+    urls_path = Path(project_name) / "urls.py"
+    if not urls_path.exists():
+        print(f"[yellow]Warning: Could not find urls.py at {urls_path}. Skipping.[/yellow]")
+        return
+
+    content = urls_path.read_text(encoding="utf-8")
+
+    if f"apps.{app_name}.urls" in content:
+        print(f"[yellow]App '{app_name}' is already mapped in urls.py[/yellow]")
+        return
+
+    if "include" not in content:
+        content = re.sub(r"(from django\.urls import.*?path)", r"\1, include", content)
+
+    if "urlpatterns = [" in content:
+        content = content.replace(
+            "urlpatterns = [",
+            f"urlpatterns = [\n    path('api/{app_name}/', include('apps.{app_name}.urls')),"
+        )
+        urls_path.write_text(content, encoding="utf-8")
+        print(f"[green]✔ Mapped /api/{app_name}/ in {project_name}/urls.py[/green]")
+    else:
+        print("[yellow]Warning: Could not find urlpatterns in urls.py[/yellow]")
+
+
+def create_app_urls(app_name: str):
+    urls_path = Path("apps") / app_name / "urls.py"
+    content = f"""from django.urls import path
+from . import views
+
+app_name = '{app_name}'
+
+urlpatterns = [
+    # path('', views.MyView.as_view(), name='my-view'),
+]
+"""
+    urls_path.write_text(content, encoding="utf-8")
+
+
+def create_app_command(name: str = typer.Argument(..., help="The name of the Django app to create")):
+    check_virtual_environment()
+    validate_name(name, "app name")
+
+    if not Path("manage.py").exists():
+        print("[red]Error: manage.py not found. Run this command from your Django project root.[/red]")
+        raise typer.Exit(1)
+
+    app_path = Path("apps") / name
+    if app_path.exists():
+        print(f"[red]Error: App '{name}' already exists at apps/{name}.[/red]")
+        raise typer.Exit(1)
+
+    Path("apps").mkdir(exist_ok=True)
+
+    print(f"[cyan]Creating app '{name}'...[/cyan]")
+    result = subprocess.run(
+        [sys.executable, "manage.py", "startapp", name, f"apps/{name}"],
+        capture_output=True, text=True
+    )
+    if result.returncode != 0:
+        print(f"[red]Error creating app:\n{result.stderr}[/red]")
+        raise typer.Exit(1)
+
+    (Path(f"apps/{name}") / "__init__.py").touch()
+
+    # Fix apps.py name
+    apps_py_path = Path(f"apps/{name}/apps.py")
+    if apps_py_path.exists():
+        apps_content = apps_py_path.read_text(encoding="utf-8")
+        apps_content = re.sub(rf"name\s*=\s*['\"]{name}['\"]", f"name = 'apps.{name}'", apps_content)
+        apps_py_path.write_text(apps_content, encoding="utf-8")
+
+    try:
+        project_name = get_project_name()
+        update_settings(project_name, name)
+        update_urls(project_name, name)
+        create_app_urls(name)
+        print(f"[bold green]✅ App '{name}' created and configured successfully![/bold green]")
+    except Exception as e:
+        print(f"[red]Error during auto-configuration: {str(e)}[/red]")

djboost-0.1.0/djboost/commands/create_project.py

@@ -0,0 +1,6 @@
+import typer
+from djboost.generator import create_project
+
+
+def create_project_command(name: str = typer.Argument("core", help="The name of the Django project")):
+    create_project(name)

djboost-0.1.0/djboost/commands/remove_cicd.py

@@ -0,0 +1,34 @@
+import os
+import shutil
+import typer
+from rich import print
+from djboost.generator import check_virtual_environment
+
+def remove_cicd_command(provider: str = typer.Argument(..., help="The CI/CD provider to remove (github or gitlab)")):
+    check_virtual_environment()
+    provider = provider.lower()
+    if provider == "github":
+        github_dir = ".github"
+        if os.path.exists(github_dir):
+            try:
+                shutil.rmtree(github_dir)
+                print("[green]GitHub Actions workflow removed successfully![/green]")
+            except Exception as e:
+                print(f"[red]Failed to remove GitHub Actions workflow: {e}[/red]")
+        else:
+            print("[yellow]GitHub Actions workflow is not present in this project.[/yellow]")
+            
+    elif provider == "gitlab":
+        gitlab_file = ".gitlab-ci.yml"
+        if os.path.exists(gitlab_file):
+            try:
+                os.remove(gitlab_file)
+                print("[green]GitLab CI pipeline removed successfully![/green]")
+            except Exception as e:
+                print(f"[red]Failed to remove GitLab CI pipeline: {e}[/red]")
+        else:
+            print("[yellow]GitLab CI pipeline is not present in this project.[/yellow]")
+            
+    else:
+        print(f"[red]Error: Unsupported provider '{provider}'. Supported providers are: github, gitlab.[/red]")
+        raise typer.Exit(code=1)