codefortify-starter 1.0.0__py3-none-any.whl

codefortify_starter/validators.py

@@ -0,0 +1,70 @@
+"""Validation and normalization helpers for CLI input."""
+
+from __future__ import annotations
+
+import keyword
+import re
+from dataclasses import dataclass
+
+from codefortify_starter.constants import VALID_DATABASES
+
+
+PROJECT_NAME_RE = re.compile(r"^[A-Za-z][A-Za-z0-9_-]*$")
+PROJECT_SLUG_RE = re.compile(r"^[a-z_][a-z0-9_]*$")
+
+
+class ValidationError(ValueError):
+    """Raised when user-provided generator inputs are invalid."""
+
+
+@dataclass(frozen=True)
+class ProjectIdentity:
+    """Normalized project naming attributes."""
+
+    project_name: str
+    project_slug: str
+    project_title: str
+    project_package: str
+    project_class_name: str
+
+
+def build_project_identity(raw_name: str) -> ProjectIdentity:
+    """Validate and normalize the requested project name."""
+    project_name = raw_name.strip()
+    if not project_name:
+        raise ValidationError("Project name cannot be empty.")
+    if "/" in project_name or "\\" in project_name:
+        raise ValidationError("Project name must not contain path separators.")
+    if not PROJECT_NAME_RE.fullmatch(project_name):
+        raise ValidationError(
+            "Project name must start with a letter and contain only letters, numbers, hyphens, or underscores."
+        )
+
+    project_slug = project_name.lower().replace("-", "_")
+    if not PROJECT_SLUG_RE.fullmatch(project_slug):
+        raise ValidationError("Unable to build a valid Python package slug from the project name.")
+    if keyword.iskeyword(project_slug):
+        raise ValidationError(f"'{project_slug}' is a reserved Python keyword.")
+
+    class_name = "".join(part.capitalize() for part in project_slug.split("_"))
+    title = class_name or project_slug.capitalize()
+    return ProjectIdentity(
+        project_name=project_name,
+        project_slug=project_slug,
+        project_title=title,
+        project_package=project_slug,
+        project_class_name=class_name,
+    )
+
+
+def normalize_database(requested_database: str | None, *, use_docker: bool) -> str:
+    """Resolve database selection defaults and validate explicit values."""
+    if requested_database is None:
+        return "postgres" if use_docker else "sqlite"
+
+    database = requested_database.strip().lower()
+    if database not in VALID_DATABASES:
+        valid_values = ", ".join(VALID_DATABASES)
+        raise ValidationError(f"Unsupported database '{requested_database}'. Choose one of: {valid_values}.")
+    return database
+

codefortify_starter-1.0.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,60 @@
+codefortify_starter/__init__.py,sha256=eIQuq0aj8MjFppFiwY4qNH2--4o8yzrH9hCm4c3kdOA,189
+codefortify_starter/__main__.py,sha256=2AQ0rURMaY59nRb06NUCCxZ2dNqSQxvxDfd1V0HUFS8,82
+codefortify_starter/cli.py,sha256=TW-yiDzbg8zHPbnkyk-pEyBYBzXCfbo5KV1ZVDXqmrc,3773
+codefortify_starter/constants.py,sha256=mL0o3q2z2o9xAnzja7muVSqLHGWgBeZGRBqAOIWhQn4,1225
+codefortify_starter/generator.py,sha256=xtv0UxC7f55w3UcTR2iDYA-cppy1WdrIKZIfCEQTSdU,8856
+codefortify_starter/template_engine.py,sha256=QMWcYg1uCl22yKBwAmanbK-OJqBRinTxn1_esru5NjY,2416
+codefortify_starter/validators.py,sha256=F0_Uf7_FV0cMvewMil5eUVvks78prb6TGPL8YOWOZDY,2430
+codefortify_starter/templates/base_project/README.md.jinja,sha256=Lf3htG3-1VPeNKaWzA26sSUtcXuRav-s_dwNMG0Nps8,1357
+codefortify_starter/templates/base_project/dot-env.example.jinja,sha256=P835WHPkZLmOZrypDVqwxWCjJayTI67p5YpHxoKI0XI,2149
+codefortify_starter/templates/base_project/dot-gitignore,sha256=woqUCvO-I6mZ-hrgYMGHTeuNU2oBqvk15_3iXsW756M,308
+codefortify_starter/templates/base_project/manage.py.jinja,sha256=xs_a6AVI9Nv_Klnk57k0S8tB1yJFVBQP79rL0UQThKw,274
+codefortify_starter/templates/base_project/apps/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+codefortify_starter/templates/base_project/apps/home/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+codefortify_starter/templates/base_project/apps/home/apps.py.jinja,sha256=VtvR6nzdPbsS9jbF7soytpBUf8IEovQVB4eVvxEzkT4,146
+codefortify_starter/templates/base_project/apps/home/tests.py.jinja,sha256=IL4Lf8hwQ6fi97-L3gLtlPOZCl4_zn0fMettwMLGo8w,595
+codefortify_starter/templates/base_project/apps/home/urls.py.jinja,sha256=MMcTp2IXiCJ3xb-hAYZhtxR4CDe4bqBbBDPjxPIq30Y,288
+codefortify_starter/templates/base_project/apps/home/views.py.jinja,sha256=rlmZC5dLoftHiU3xVGJHzqefuM6Qd2MnjpOVBItve58,264
+codefortify_starter/templates/base_project/apps/home/templates/home/index.html.jinja,sha256=sHJ_ZvFFdnOnZbuCjh4huMBXor8GO2sjSR6gXLv7qD0,523
+codefortify_starter/templates/base_project/core/__init__.py.jinja,sha256=8-lzmnk3e_XuZR3kZl4hGZBb6Fyz3lw4VZuyK42lpwM,168
+codefortify_starter/templates/base_project/core/asgi.py.jinja,sha256=PP_KiqQLcF1IW0-KTtb0QqN1W91yuWPbOhlXBWNWpiM,160
+codefortify_starter/templates/base_project/core/env.py.jinja,sha256=zSJKcdtnp_OlK2rFdTUz9NXVuGcaDIgdU-5zX0vH2cs,1674
+codefortify_starter/templates/base_project/core/urls.py.jinja,sha256=Asm7_XCqbzAhVsTVUBe-q-Abxq06k-6k9Gv5slW0g9Q,682
+codefortify_starter/templates/base_project/core/views.py.jinja,sha256=ONYrnPcRjY11Nq6B4KpTnIu95H-bCj4SRloXCh3MREs,1956
+codefortify_starter/templates/base_project/core/wsgi.py.jinja,sha256=MBYweKxuRQsMOIelX3rZo0iGAEsFqFCnKNweaQq5cH0,160
+codefortify_starter/templates/base_project/core/middleware/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+codefortify_starter/templates/base_project/core/middleware/exceptions.py,sha256=faAb-g8R0J588TYlAiZGn3gs4frtHnHDg7WmYaO2-U0,768
+codefortify_starter/templates/base_project/core/middleware/security.py,sha256=6-jERDJGdwhuKVCc8WBbz3HDnTqYt9Jja_SKUy1oLbM,513
+codefortify_starter/templates/base_project/core/settings/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+codefortify_starter/templates/base_project/core/settings/base.py.jinja,sha256=zvwB26ugjjE1Eguu7sr-EaQtc9Gld6MUkHR9_K6IF9k,4884
+codefortify_starter/templates/base_project/core/settings/dev.py.jinja,sha256=B99Jq9vh_5jMboFBKeJqYzFOHme8jI_ZT3oYxTaqKi8,140
+codefortify_starter/templates/base_project/core/settings/production.py.jinja,sha256=y5yEjGRBLpWD_tE3d4IkZnq9YRCfojYDGoYdnwLmkcA,871
+codefortify_starter/templates/base_project/core/templates/errors/400.html,sha256=NP4INirYFSAQPw9gx7rOB8QWRp2ZvnNc6h49YL9ttUg,138
+codefortify_starter/templates/base_project/core/templates/errors/403.html,sha256=MbT4KuCQp3K4aXOx7sIulp4OoPucv6a9TNeLRZ-Fp44,150
+codefortify_starter/templates/base_project/core/templates/errors/404.html,sha256=i48qo-ZJ8A8lpACSL2DHL1Ta5NeXmStwLvUwX9agbAs,139
+codefortify_starter/templates/base_project/core/templates/errors/405.html,sha256=xtF1KGSh_a7jTEfXwUw7VDJDpLHfVpmOY9ERLw06ESs,152
+codefortify_starter/templates/base_project/core/templates/errors/500.html,sha256=7CyIDPYtiAXXcimIbbneKpc7ZvOpHqbQ-oEUEvmle-4,149
+codefortify_starter/templates/base_project/static/css/main.css,sha256=IVUQ885XgRJpq-dQm4Agk3uEw51SUODf_CaxfHAzCbg,241
+codefortify_starter/templates/base_project/templates/base.html.jinja,sha256=msJNjXXqBdXyB5Iw5k9uv9PhUu3y5J4LKX6L2-BYBbg,497
+codefortify_starter/templates/features/celery/apps/home/tasks.py.jinja,sha256=JrXEd0gLi7fBrqcfGnr7bIqdJLRfjnP3_NObfY_LmPI,77
+codefortify_starter/templates/features/celery/core/celery.py.jinja,sha256=f0036dyYR_JD_fioa10WhxvVcDOiN6bdG8TCeYVlCe4,362
+codefortify_starter/templates/features/docker/DOCKER_README.md.jinja,sha256=OAmg5MKMkYzNj5SdkFHprAVdxCmncQi5SjtF6hpeRGk,1137
+codefortify_starter/templates/features/docker/Dockerfile.jinja,sha256=ABJoa7eXRFZek9poniWdYfsk6U_dQugMeLYOqjVeT6U,455
+codefortify_starter/templates/features/docker/docker-compose.prod.yml.jinja,sha256=IJtMR8ZDUn_dal-sHwSBylGmqa_hNd6L0yrOJehogWI,4794
+codefortify_starter/templates/features/docker/docker-compose.yml.jinja,sha256=xDpaUIthqS3a6n9seLxwNq_DbO5MY4KdHCLNaBlTRjg,6399
+codefortify_starter/templates/features/docker/docker_deploy.sh.jinja,sha256=aLt3SHBE2OgL6uQfiV7oflvh6K82CiXUA3QyQBjKvb8,2723
+codefortify_starter/templates/features/docker/dot-dockerignore,sha256=2Sdou5O_tXMH9PGsUVaYItjdfRFgKzF4cKDezzSd-vc,90
+codefortify_starter/templates/features/docker/entrypoint.sh.jinja,sha256=pCdX_Tt5eITqMGofpykl3i1k2uaOd-8xKorAz1wHLKI,2475
+codefortify_starter/templates/features/drf/apps/api/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+codefortify_starter/templates/features/drf/apps/api/apps.py.jinja,sha256=-EQ9amecVqf6LQ8O7dl86-ENAqxbm2f3zuEt3y2dxPw,144
+codefortify_starter/templates/features/drf/apps/api/serializers.py,sha256=uFtBEuoKKIOPqAk11Bknx7d3wXwPSAwxh_f7tOMV-1c,165
+codefortify_starter/templates/features/drf/apps/api/tests.py,sha256=cCsU3I_Gntrn4DKFjvMRv0hiqCb7FJEbibk22sIovD0,365
+codefortify_starter/templates/features/drf/apps/api/urls.py,sha256=cX10n5SKnPw86YZSyB7bscGoOMeBTJcJuBW09A2wiow,171
+codefortify_starter/templates/features/drf/apps/api/views.py,sha256=DROkoGEUCirjidu8MyLyXzy-GBfDTelOdKzTZCYwdyk,495
+codefortify_starter/templates/features/htmx/templates/partials/example.html.jinja,sha256=K-u1KawFcofhb3qv2ttDRRbSb514ScxSeThm88Rsl5c,136
+codefortify_starter-1.0.0.dist-info/licenses/LICENSE,sha256=1-ZctcUxkGU1x6Ioi7pi1yjTrYgjZX5hYVP9EnPMcQY,1069
+codefortify_starter-1.0.0.dist-info/METADATA,sha256=ibSj3uLiHxSL-znb2aoGmZ0duZFMjzydVBqW5jr7l1k,7623
+codefortify_starter-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+codefortify_starter-1.0.0.dist-info/entry_points.txt,sha256=r2p0PulHgiMGVRM3HmJm4H2seY01-fxumj3pf6X28Pk,74
+codefortify_starter-1.0.0.dist-info/top_level.txt,sha256=fnRqkfOK2-8EKUg0c_iHRQEnsgnYBesv_GDA26F8xCU,20
+codefortify_starter-1.0.0.dist-info/RECORD,,

codefortify_starter-1.0.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
+

codefortify_starter-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codefortify-startproject = codefortify_starter.cli:main

codefortify_starter-1.0.0.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+codefortify_starter