Version: 1.0.0
Engineer: Ashmeet Singh
This document outlines the full capabilities of the Project Engine. The engine supports two primary flows: Interactive UI (Menu-driven) and Headless CLI (Flag-driven).
The engine behaves differently based on the -t (type) flag:
| Strategy | Behavior |
|---|---|
auto_config |
Zero-Config. Uses smart defaults for the chosen framework. Best for rapid prototyping. |
standard |
The Balanced Build. Generates common folder structures (routes, models, schemas). |
production |
Enterprise Ready. Includes full infrastructure suites (Docker, K8s) and strict folder separation. |
custom |
Total Control. Enables manual folder selection and individual __init__.py configuration. |
Use these flags to bypass menus and automate your workflow.
name: The name of your project folder.-f, --framework:fastapi,flask,django,others.-s, --server: Specify the runner (e.g.,uvicorn,gunicorn,hypercorn).-t, --type: The build strategy (auto_config,standard,production,custom).
--folders: Manually define every directory to be created.--packages: Define which of those folders should be Python packages (adds__init__.py).
--db: Set the database engine (sqlite,postgres,mysql,mongodb).--venv: Enable virtual environment creation (yorn).
--docker:dockerfile,docker-compose,.dockerignore.--github:main.yml,ci.yml,cd.yml.--k8s:deployment.yml,service.yml,ingress.yml.--jenkins:Jenkinsfile.
Builds a FastAPI project with SQLite and a VENV instantly.
init-app quick_api -f fastapi -t auto_config --venv y
Builds a Django + Postgres app with Docker and GitHub Actions.
init-app pro_backend -f django -t production --db postgres --docker dockerfile docker-compose --github main.yml
The most powerful command. Manually define folders and only make src and app Python packages.
init-app bespoke_engine -f fastapi -t custom \
--folders src app docs tests logs \
--packages src app \
--db mongodb --venv y
Unlike standard generators that put __init__.py everywhere, this engine uses an init_strategy map. It only converts a folder into a Python package if explicitly told to or if the framework requires it.
When building Django, the engine performs "surgical" regex injections:
- Settings Patching: Automatically adds your App to
INSTALLED_APPS. - Security Injection: Moves
SECRET_KEYto environment variable logic. - DRF Integration: If DRF is detected, it injects the
REST_FRAMEWORKconfiguration block automatically.
The engine contains a security layer that prevents any template rendering from writing into the ui/ directory, protecting the engine's core interface assets during a project build.
