codefortify-starter 1.0.0__tar.gz

codefortify_starter-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Codefortify
+
+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.
+

codefortify_starter-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include codefortify_starter/templates *
+

codefortify_starter-1.0.0/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.4
+Name: codefortify-starter
+Version: 1.0.0
+Summary: A production-ready Django project generator with optional HTMX, DRF, Docker, Celery, Redis, PostgreSQL, and MySQL support.
+Author-email: Codefortify <maintainers@codefortify.dev>
+License: MIT
+Project-URL: Homepage, https://github.com/codefortify/codefortify-starter
+Project-URL: Source, https://github.com/codefortify/codefortify-starter
+Keywords: django,django-starter,django-boilerplate,project-generator,python,codefortify,htmx,drf,docker,celery,redis,postgresql,mysql,cookiecutter-alternative,backend
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer<1.0.0,>=0.12.0
+Requires-Dist: rich<14.0.0,>=13.7.0
+Requires-Dist: Jinja2<4.0.0,>=3.1.0
+Dynamic: license-file
+
+# codefortify-starter
+
+`codefortify-starter` is a professional Django project starter generator for building clean, scalable, and production-ready Django applications faster.
+
+It creates a modern Django architecture with a structured settings layout, reusable app organization, environment-based configuration, templates, static/media setup, and optional support for HTMX, Django REST Framework, Docker, Celery, Redis, PostgreSQL, and MySQL.
+
+Whether you need a simple Django MVT project or a full API-ready Dockerized architecture with background workers, `codefortify-starter` gives you a consistent foundation for starting new projects.
+
+## What It Is
+
+`codefortify-starter` is a PyPI-installable Django project generator that helps developers quickly scaffold clean, maintainable, production-ready Django architectures.
+
+By default, it generates a simple Django MVT project. With flags, it can add HTMX, DRF, Docker, Celery, Redis, PostgreSQL, and MySQL.
+
+## Why It Exists
+
+Most Django projects repeat the same setup work: project layout, settings split, dependency wiring, env bootstrapping, and deployment scaffolding. `codefortify-starter` reduces that repeated effort and standardizes project initialization.
+
+## Who Should Use It
+
+- Django developers starting new applications
+- Teams that want a consistent starter architecture
+- Backend/API engineers who need optional DRF, Docker, and Celery setup
+- Developers who want a lightweight alternative to larger templating frameworks
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install codefortify-starter
+```
+
+Install an exact version:
+
+```bash
+pip install codefortify-starter==1.0.0
+```
+
+Verify the CLI:
+
+```bash
+codefortify-startproject --help
+```
+
+## Quick Start
+
+Create a basic Django MVT project:
+
+```bash
+codefortify-startproject myproject
+cd myproject
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+cp .env.example .env
+python manage.py migrate
+python manage.py runserver
+```
+
+## Supported CLI Flags
+
+- `--htmx`
+- `--drf`
+- `--docker`
+- `--celery`
+- `--database [sqlite|postgres|mysql]`
+- `--no-git`
+- `--force`
+- `--directory PATH`
+- `--all`
+
+## Command Examples
+
+```bash
+codefortify-startproject myproject
+codefortify-startproject myproject --htmx
+codefortify-startproject myproject --drf
+codefortify-startproject myproject --docker
+codefortify-startproject myproject --celery
+codefortify-startproject myproject --docker --celery
+codefortify-startproject myproject --drf --docker --celery
+codefortify-startproject myproject --database postgres
+codefortify-startproject myproject --database mysql
+codefortify-startproject myproject --no-git
+codefortify-startproject myproject --force
+codefortify-startproject myproject --directory /path/to/projects
+codefortify-startproject myproject --all
+```
+
+`--all` is equivalent to:
+
+```bash
+codefortify-startproject myproject --htmx --drf --docker --celery --database postgres
+```
+
+## Feature Matrix
+
+| Feature | Flag | Description |
+|---|---|---|
+| Django MVT | default | Clean Django project with settings, templates, static/media, and home app |
+| HTMX | `--htmx` | Adds `django-htmx`, middleware, and example partial views |
+| Django REST Framework | `--drf` | Adds DRF, API app, API routes, serializers, and tests |
+| Docker | `--docker` | Adds Dockerfile, docker-compose, entrypoint, deployment script, and Docker docs |
+| Celery + Redis | `--celery` | Adds Celery config, Redis broker settings, and example task |
+| PostgreSQL | `--database postgres` | Adds PostgreSQL-ready configuration |
+| MySQL | `--database mysql` | Adds MySQL-ready configuration |
+| Full stack | `--all` | Adds HTMX, DRF, Docker, Celery, Redis, and PostgreSQL |
+
+## Generated Architecture
+
+```text
+myproject/
+├── apps/
+│   └── home/
+├── core/
+│   ├── settings/
+│   │   ├── base.py
+│   │   ├── dev.py
+│   │   └── production.py
+│   ├── urls.py
+│   ├── asgi.py
+│   └── wsgi.py
+├── templates/
+├── static/
+├── media/
+├── manage.py
+├── requirements.txt
+├── .env.example
+└── README.md
+```
+
+Feature-specific files are added only when their flags are selected (for example `apps/api`, `core/celery.py`, `Dockerfile`, compose files, and task modules).
+
+## Database Options
+
+- Default without `--docker`: SQLite
+- Default with `--docker`: PostgreSQL
+- Explicit: `--database postgres`, `--database mysql`, or `--database sqlite`
+
+Generated settings safely handle an empty `DATABASE_URL` and support local fallback behavior for development.
+
+## HTMX Usage
+
+Generate with HTMX:
+
+```bash
+codefortify-startproject myproject --htmx
+```
+
+The generated project includes HTMX middleware and an example partial endpoint.
+
+## DRF Usage
+
+Generate with DRF:
+
+```bash
+codefortify-startproject myproject --drf
+```
+
+The generated API app includes a health endpoint:
+
+- `GET /api/health/`
+
+## Docker Usage
+
+```bash
+codefortify-startproject myproject --docker
+cd myproject
+cp .env.example .env
+docker compose build
+docker compose up -d
+docker compose exec web python manage.py migrate
+```
+
+## Celery Usage
+
+Generate with Celery support:
+
+```bash
+codefortify-startproject myproject --celery
+```
+
+Run worker locally:
+
+```bash
+celery -A core worker -l info
+```
+
+## Full Stack Usage
+
+```bash
+codefortify-startproject myproject --all
+cd myproject
+cp .env.example .env
+docker compose build
+docker compose up -d
+docker compose ps
+```
+
+## Local Development (This Package)
+
+```bash
+python -m venv .pkgvenv
+source .pkgvenv/bin/activate
+pip install -r requirements.txt
+pip install -e .
+python -m pytest -q tests
+```
+
+## Build and Publish
+
+Build and validate:
+
+```bash
+rm -rf dist build *.egg-info
+python -m build
+twine check dist/*
+```
+
+Publish to TestPyPI:
+
+```bash
+twine upload --repository testpypi dist/*
+```
+
+Publish to PyPI:
+
+```bash
+twine upload dist/*
+```
+
+## Testing from TestPyPI
+
+Use this only for testing pre-release package builds:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple \
+  codefortify-starter==1.0.0
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE).

codefortify_starter-1.0.0/README.md

@@ -0,0 +1,245 @@
+# codefortify-starter
+
+`codefortify-starter` is a professional Django project starter generator for building clean, scalable, and production-ready Django applications faster.
+
+It creates a modern Django architecture with a structured settings layout, reusable app organization, environment-based configuration, templates, static/media setup, and optional support for HTMX, Django REST Framework, Docker, Celery, Redis, PostgreSQL, and MySQL.
+
+Whether you need a simple Django MVT project or a full API-ready Dockerized architecture with background workers, `codefortify-starter` gives you a consistent foundation for starting new projects.
+
+## What It Is
+
+`codefortify-starter` is a PyPI-installable Django project generator that helps developers quickly scaffold clean, maintainable, production-ready Django architectures.
+
+By default, it generates a simple Django MVT project. With flags, it can add HTMX, DRF, Docker, Celery, Redis, PostgreSQL, and MySQL.
+
+## Why It Exists
+
+Most Django projects repeat the same setup work: project layout, settings split, dependency wiring, env bootstrapping, and deployment scaffolding. `codefortify-starter` reduces that repeated effort and standardizes project initialization.
+
+## Who Should Use It
+
+- Django developers starting new applications
+- Teams that want a consistent starter architecture
+- Backend/API engineers who need optional DRF, Docker, and Celery setup
+- Developers who want a lightweight alternative to larger templating frameworks
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install codefortify-starter
+```
+
+Install an exact version:
+
+```bash
+pip install codefortify-starter==1.0.0
+```
+
+Verify the CLI:
+
+```bash
+codefortify-startproject --help
+```
+
+## Quick Start
+
+Create a basic Django MVT project:
+
+```bash
+codefortify-startproject myproject
+cd myproject
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+cp .env.example .env
+python manage.py migrate
+python manage.py runserver
+```
+
+## Supported CLI Flags
+
+- `--htmx`
+- `--drf`
+- `--docker`
+- `--celery`
+- `--database [sqlite|postgres|mysql]`
+- `--no-git`
+- `--force`
+- `--directory PATH`
+- `--all`
+
+## Command Examples
+
+```bash
+codefortify-startproject myproject
+codefortify-startproject myproject --htmx
+codefortify-startproject myproject --drf
+codefortify-startproject myproject --docker
+codefortify-startproject myproject --celery
+codefortify-startproject myproject --docker --celery
+codefortify-startproject myproject --drf --docker --celery
+codefortify-startproject myproject --database postgres
+codefortify-startproject myproject --database mysql
+codefortify-startproject myproject --no-git
+codefortify-startproject myproject --force
+codefortify-startproject myproject --directory /path/to/projects
+codefortify-startproject myproject --all
+```
+
+`--all` is equivalent to:
+
+```bash
+codefortify-startproject myproject --htmx --drf --docker --celery --database postgres
+```
+
+## Feature Matrix
+
+| Feature | Flag | Description |
+|---|---|---|
+| Django MVT | default | Clean Django project with settings, templates, static/media, and home app |
+| HTMX | `--htmx` | Adds `django-htmx`, middleware, and example partial views |
+| Django REST Framework | `--drf` | Adds DRF, API app, API routes, serializers, and tests |
+| Docker | `--docker` | Adds Dockerfile, docker-compose, entrypoint, deployment script, and Docker docs |
+| Celery + Redis | `--celery` | Adds Celery config, Redis broker settings, and example task |
+| PostgreSQL | `--database postgres` | Adds PostgreSQL-ready configuration |
+| MySQL | `--database mysql` | Adds MySQL-ready configuration |
+| Full stack | `--all` | Adds HTMX, DRF, Docker, Celery, Redis, and PostgreSQL |
+
+## Generated Architecture
+
+```text
+myproject/
+├── apps/
+│   └── home/
+├── core/
+│   ├── settings/
+│   │   ├── base.py
+│   │   ├── dev.py
+│   │   └── production.py
+│   ├── urls.py
+│   ├── asgi.py
+│   └── wsgi.py
+├── templates/
+├── static/
+├── media/
+├── manage.py
+├── requirements.txt
+├── .env.example
+└── README.md
+```
+
+Feature-specific files are added only when their flags are selected (for example `apps/api`, `core/celery.py`, `Dockerfile`, compose files, and task modules).
+
+## Database Options
+
+- Default without `--docker`: SQLite
+- Default with `--docker`: PostgreSQL
+- Explicit: `--database postgres`, `--database mysql`, or `--database sqlite`
+
+Generated settings safely handle an empty `DATABASE_URL` and support local fallback behavior for development.
+
+## HTMX Usage
+
+Generate with HTMX:
+
+```bash
+codefortify-startproject myproject --htmx
+```
+
+The generated project includes HTMX middleware and an example partial endpoint.
+
+## DRF Usage
+
+Generate with DRF:
+
+```bash
+codefortify-startproject myproject --drf
+```
+
+The generated API app includes a health endpoint:
+
+- `GET /api/health/`
+
+## Docker Usage
+
+```bash
+codefortify-startproject myproject --docker
+cd myproject
+cp .env.example .env
+docker compose build
+docker compose up -d
+docker compose exec web python manage.py migrate
+```
+
+## Celery Usage
+
+Generate with Celery support:
+
+```bash
+codefortify-startproject myproject --celery
+```
+
+Run worker locally:
+
+```bash
+celery -A core worker -l info
+```
+
+## Full Stack Usage
+
+```bash
+codefortify-startproject myproject --all
+cd myproject
+cp .env.example .env
+docker compose build
+docker compose up -d
+docker compose ps
+```
+
+## Local Development (This Package)
+
+```bash
+python -m venv .pkgvenv
+source .pkgvenv/bin/activate
+pip install -r requirements.txt
+pip install -e .
+python -m pytest -q tests
+```
+
+## Build and Publish
+
+Build and validate:
+
+```bash
+rm -rf dist build *.egg-info
+python -m build
+twine check dist/*
+```
+
+Publish to TestPyPI:
+
+```bash
+twine upload --repository testpypi dist/*
+```
+
+Publish to PyPI:
+
+```bash
+twine upload dist/*
+```
+
+## Testing from TestPyPI
+
+Use this only for testing pre-release package builds:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple \
+  codefortify-starter==1.0.0
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE).

codefortify_starter-1.0.0/codefortify_starter/__init__.py

@@ -0,0 +1,7 @@
+"""Codefortify starter project generator package."""
+
+from codefortify_starter.constants import PACKAGE_VERSION
+
+__all__ = ["PACKAGE_VERSION", "__version__"]
+
+__version__ = PACKAGE_VERSION

codefortify_starter-1.0.0/codefortify_starter/__main__.py

@@ -0,0 +1,6 @@
+from codefortify_starter.cli import main
+
+
+if __name__ == "__main__":
+    main()
+

codefortify_starter-1.0.0/codefortify_starter/cli.py

@@ -0,0 +1,103 @@
+"""CLI entry point for project generation."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+from rich.console import Console
+
+from codefortify_starter.generator import StarterProjectGenerator, build_generation_options
+from codefortify_starter.validators import ValidationError, build_project_identity, normalize_database
+
+
+console = Console()
+
+
+def run(
+    project_name: str = typer.Argument(..., help="Project directory name to create."),
+    htmx: bool = typer.Option(False, "--htmx", help="Include HTMX integration."),
+    drf: bool = typer.Option(False, "--drf", help="Include Django REST Framework starter API."),
+    docker: bool = typer.Option(False, "--docker", help="Include Docker and Compose files."),
+    celery: bool = typer.Option(False, "--celery", help="Include Celery + Redis task setup."),
+    database: str | None = typer.Option(
+        None,
+        "--database",
+        help="Database backend to configure: sqlite, postgres, or mysql.",
+    ),
+    no_git: bool = typer.Option(False, "--no-git", help="Skip git repository initialization."),
+    force: bool = typer.Option(False, "--force", help="Allow generation into an existing directory."),
+    directory: Path = typer.Option(Path("."), "--directory", help="Parent directory for the generated project."),
+    all_features: bool = typer.Option(
+        False,
+        "--all",
+        help="Enable full-stack preset: --htmx --drf --docker --celery --database postgres.",
+    ),
+) -> None:
+    """Generate a Django starter project."""
+    try:
+        if all_features:
+            htmx = True
+            drf = True
+            docker = True
+            celery = True
+            if database is None:
+                database = "postgres"
+
+        resolved_database = normalize_database(database, use_docker=docker)
+        identity = build_project_identity(project_name)
+
+        options = build_generation_options(
+            project_name=identity.project_name,
+            project_slug=identity.project_slug,
+            project_title=identity.project_title,
+            project_package=identity.project_package,
+            project_class_name=identity.project_class_name,
+            directory=directory.resolve(),
+            database=resolved_database,
+            use_htmx=htmx,
+            use_drf=drf,
+            use_docker=docker,
+            use_celery=celery,
+            no_git=no_git,
+            force=force,
+        )
+        generator = StarterProjectGenerator()
+        result = generator.generate(options)
+    except (ValidationError, FileExistsError, NotADirectoryError, RuntimeError) as exc:
+        console.print(f"[bold red]Error:[/bold red] {exc}")
+        raise typer.Exit(code=1) from exc
+
+    selected_features = []
+    if htmx:
+        selected_features.append("htmx")
+    if drf:
+        selected_features.append("drf")
+    if docker:
+        selected_features.append("docker")
+    if celery:
+        selected_features.append("celery")
+    features_text = ", ".join(selected_features) if selected_features else "base"
+
+    console.print(
+        f"[bold green]Created[/bold green] {result.project_path} "
+        f"(database={resolved_database}, features={features_text})"
+    )
+    if result.warnings:
+        for warning in result.warnings:
+            console.print(f"[yellow]Warning:[/yellow] {warning}")
+
+    console.print("Next steps:")
+    console.print(f"  1. cd {result.project_path}")
+    console.print("  2. python -m venv .venv && source .venv/bin/activate")
+    console.print("  3. pip install -r requirements.txt")
+    console.print("  4. cp .env.example .env")
+    console.print("  5. python manage.py migrate && python manage.py runserver")
+
+
+def main() -> None:
+    typer.run(run)
+
+
+if __name__ == "__main__":
+    main()