🚀 dj-scaffold
dj-scaffold is your ultimate CLI companion for rapidly scaffolding modern, production-ready Django applications. Inspired by tools like create-next-app, it gives you an interactive, zero-headache setup experience so you can start coding your business logic instantly.
✨ Why dj-scaffold?
- ⚡ Interactive Setup: Answer a few prompts and your project is ready.
- 🐳 Docker-Ready: Instantly containerized with zero setup required.
- 🛡️ Secure & Configured: CORS, CSP, and JWT auth out of the box.
- 🏗️ Modern Architecture: Enforces a scalable Service Layer pattern for your apps.
📦 Quick Start
Install the CLI globally or in your virtual environment:
pip install dj-scaffold-imhotep
The Standard Workflow
-
Create your project:
dj-scaffold create(Answer the prompts to choose your database and API framework).
-
Start the server:
cd <your-project-name> docker compose up -d --build
(This automatically runs migrations and creates a superuser!)
-
Add a new app:
dj-scaffold startapp(This wires a new app into your project using the Service Layer architecture).
📚 Documentation
Dive deep into what dj-scaffold does under the hood. Check out our detailed documentation guides:
- ⌨️ CLI Commands Reference – Full list of commands and interactive menus.
- 📖 Project Overview – Understand what gets generated and why.
- 🔑 Default Admin & Credentials – Learn how the auto-superuser works.
- 🗄️ Database Options – Details on PostgreSQL, MySQL, and SQLite setups.
- 📡 API Framework Flavors – Learn about DRF, Django Ninja, and Standard Django setups.
- 🏗️ Architecture Layouts – Deep dive into the Service Layer pattern vs Standard layout.
🛠️ Local Development & Testing
To set up the CLI tool for local development:
-
Clone the repository:
git clone https://github.com/Imhotep-Tech/dj-scaffold.git cd dj-scaffold
-
Install in editable mode with development dependencies:
pip install -e .[dev]
-
Run the test suite:
pytest -v
If you want to contribute to the project, please see our CONTRIBUTING.md file.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dj_scaffold_imhotep-1.1.0.tar.gz.
File metadata
- Download URL: dj_scaffold_imhotep-1.1.0.tar.gz
- Upload date:
- Size: 14.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7325b8e2f83f23f3b5f0a0d6221159140f14aaf2aeb5b36bbe40245e2e943533
|
|
| MD5 |
8be2f1db2212c2f9eef1ac90c1017df8
|
|
| BLAKE2b-256 |
2c3770cedb8472b20ce4e6b4a51b1758affa46f1395a46edde840ad6e35c9cd1
|
Provenance
The following attestation bundles were made for dj_scaffold_imhotep-1.1.0.tar.gz:
Publisher:
publish-pypi.yml on Imhotep-Tech/dj-scaffold
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dj_scaffold_imhotep-1.1.0.tar.gz -
Subject digest:
7325b8e2f83f23f3b5f0a0d6221159140f14aaf2aeb5b36bbe40245e2e943533 - Sigstore transparency entry: 2143141646
- Sigstore integration time:
-
Permalink:
Imhotep-Tech/dj-scaffold@0a00e8cd7a9a16e7c395daf7572719382d59c32b -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Imhotep-Tech
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@0a00e8cd7a9a16e7c395daf7572719382d59c32b -
Trigger Event:
push
-
Statement type:
File details
Details for the file dj_scaffold_imhotep-1.1.0-py3-none-any.whl.
File metadata
- Download URL: dj_scaffold_imhotep-1.1.0-py3-none-any.whl
- Upload date:
- Size: 16.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28b58ee441cae56af697f67bc6c684fe5321c01b20c31e57538d148730b0eb96
|
|
| MD5 |
5a5a57ef283affe689b591d2779deebc
|
|
| BLAKE2b-256 |
9fb090a1684b7fa83edbdf8ecc5b6e00d5ab781262b54ca2b5f35760947e0b7e
|
Provenance
The following attestation bundles were made for dj_scaffold_imhotep-1.1.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on Imhotep-Tech/dj-scaffold
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dj_scaffold_imhotep-1.1.0-py3-none-any.whl -
Subject digest:
28b58ee441cae56af697f67bc6c684fe5321c01b20c31e57538d148730b0eb96 - Sigstore transparency entry: 2143141730
- Sigstore integration time:
-
Permalink:
Imhotep-Tech/dj-scaffold@0a00e8cd7a9a16e7c395daf7572719382d59c32b -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Imhotep-Tech
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@0a00e8cd7a9a16e7c395daf7572719382d59c32b -
Trigger Event:
push
-
Statement type: