萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

Django 專案腳手架 dj-scaffold:標準化目錄結構與開發效率提升

專案緣起

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 入口

核心功能亮點

1. 虛擬環境一鍵建立與進入


# 首次建立
cd myproject
python scripts/create_env.py

# 日常開發:進入環境
source scripts/env.rc
# 現在可直接用 $mg 替代 python manage.py
$mg runserver
$mg migrate
$mg shell

2. 標準化 App 結構 (lbstartapp)


# 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

3. 內建生產級預設配置

  • 資料庫預設 SQLite (開發) / 環境變數切換 PostgreSQL/MySQL (生產)
  • 靜態檔案 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

與官方 startproject 差異對比

特性django-admin startprojectdj-scaffold
目錄結構扁平、極簡分層、生產級標準
設定管理單一 settings.py多環境模組化
虛擬環境手動建立腳本自動化 + 別名
App 結構最小集合完整功能目錄
部署支援無WSGI 檔案 + 靜態檔案配置
文檔目錄無內建 docs/

現代替代方案

  • Cookiecutter Django:最流行、功能最全、支援 Docker/PostgreSQL/Redis/Celery/Traefik/GraphQL 等完整棧
  • Django Project Template (官方):django-admin startproject --template=...
  • 自建組織級樣板:基於 Cookiecutter 維護內部標準

dj-scaffold 解決了早期 Django 專案結構混亂問題,現代專案建議直接使用 Cookiecutter Django 獲得更完整的生態整合。

copyright © 萬盛學電腦網 all rights reserved