Django 官方 startproject 產生的結構過於簡陋,缺乏生產級目錄規範。dj-scaffold 提供標準化專案樣板,涵蓋虛擬環境、設定管理、靜態檔案、部署腳本等最佳實踐。
pip install dj-scaffold
# 或
easy_install dj-scaffold
# 建立專案
dj-scaffold.py myproject
myproject/
├── docs/ # 專案文檔目錄
├── env/ # Python 虛擬環境 (由 create_env.py 建立)
├── requirements/
│ └── requirements.pip # pip 依賴鎖定檔
├── scripts/
│ ├── create_env.py # 自動建立虛擬環境
│ └── env.rc # 啟動腳本:source env.rc 進入環境,提供 $mg 別名
├── sites/ # Django 專案核心 (可重命名)
│ ├── media/ # 用戶上傳檔案
│ ├── static/ # 專案靜態檔案 (CSS/JS/圖片)
│ ├── templates/ # 專案級模板
│ └── settings/ # 多環境設定 (base/development/production)
├── tools/ # 第三方工具腳本 (如 virtualenv.py)
└── wsgi/
└── dj_scaffold.wsgi # 生產部署 WSGI 入口
# 首次建立
cd myproject
python scripts/create_env.py
# 日常開發:進入環境
source scripts/env.rc
# 現在可直接用 $mg 替代 python manage.py
$mg runserver
$mg migrate
$mg shell
# settings.py 中加入
INSTALLED_APPS += ['dj_scaffold']
# 建立功能完整的 App
python manage.py lbstartapp blog
blog/
├── management/ # 自訂管理命令
│ └── commands/
├── static/ # App 靜態檔案
├── templates/ # App 模板
├── templatetags/ # 自訂模板標籤
├── __init__.py
├── admin.py # Admin 後台配置
├── forms.py
├── models.py
├── settings.py # App 專屬設定
├── tests.py
├── urls.py # App 路由
└── views.py
STATIC_ROOT/STATICFILES_DIRS 已配置TEMPLATE_DIRS 已設定SecurityMiddleware, WhiteNoise 整合建議
# 複製內建樣板並修改
cp -r $(python -c "import dj_scaffold; print(dj_scaffold.__path__[0])")/templates/project_template ~/my_template
# 使用自訂樣板
dj-scaffold.py --template=~/my_template myproject2
# requirements.pip 加入
Django>=4.2,<5.0
python-decouple
dj-database-url
django-environ
gunicorn
whitenoise
psycopg2-binary
redis
celery
| 特性 | django-admin startproject | dj-scaffold |
|---|---|---|
| 目錄結構 | 扁平、極簡 | 分層、生產級標準 |
| 設定管理 | 單一 settings.py | 多環境模組化 |
| 虛擬環境 | 手動建立 | 腳本自動化 + 別名 |
| App 結構 | 最小集合 | 完整功能目錄 |
| 部署支援 | 無 | WSGI 檔案 + 靜態檔案配置 |
| 文檔目錄 | 無 | 內建 docs/ |
django-admin startproject --template=...dj-scaffold 解決了早期 Django 專案結構混亂問題,現代專案建議直接使用 Cookiecutter Django 獲得更完整的生態整合。