轉自:http://www.cnblogs.com/holbrook/archive/2012/02/24/2366386.html
每個真正的程序員,可能都會夢想着能夠發布開源項目,讓自己的代碼被別人所用。 開源項目會發布到開發的版本管理系統(比如GitHub)上面,為了讓大家能夠方便使用你的代碼,項目的目錄結構應該遵循一定的規范。即使不是開源項目, 項目目錄結構符合一定的規范對你的項目管理也是有好處的。
.tx/ 如果你使用Transifex進行國際化的翻譯工作,創建此目錄config Transifex的配置文件$PROJ_NAME/ 按照你實際的項目名稱創建目錄。如果有多個子項目,就創建多個目錄docs/ 項目文檔wiki/ 如果有wiki,可以創建此目錄scripts/ 項目用到的各種腳本tests/ 測試代碼extras/ 擴展,不屬於項目必需的部分,但是與項目相關的sample、poc等,下面給出4個例子:dev_example/production_example/test1_poc/test2_poc/.gitignore 版本控制文件,現在git比較流行AUTHORS 作者清單INSTALL 安裝說明LICENSE 版權聲明MANIFEST.in 裝箱清單文件MAKEFILE 編譯腳本README 項目說明文件,其他需要的目錄下也可以放一個README文件,說明該目錄的內容setup.py python模塊的安裝腳本
在python開源項目目錄結構的基礎上,進一步定義django的目錄結構。根據django的特性,分成兩部分:project結構和app結構。
project結構
這里定義的是python開源項目目錄結構中的$PROJ_NAME目錄內的內容,需要與python開源項目目錄結構結合起來。
PROJ_NAME/
__init__.py 這幾個文件是django創建project所必須的,不做過多說明
manage.py
settings.py
urls.py
apps/ 即使是“小”工程,也建議分成多個app,每個app足夠簡單,只解決某一個方面的問題 (注1)
myapp1/
myapp2/
extra_apps/ 引用的其他app。
libs/ 加載第三方模塊,可以避免版本沖突,按照標准的site-packages管理(注2)
python*.*/ 指定python版本號
site-packages/
requirements.pip #pip的依賴說明文件
tests/ project級別的測試,對於每個app,還要有自己的測試代碼
static/ 靜態內容
css/
js/
images/
uploads/ 上傳文件所在目錄
templates/ 模板目錄,覆蓋app的模板
flatpages/
comments/
example/
app1/
app2/
templatetags/ tag目錄
注1:指定app加載,在settings.py中設置:
sys.path.insert(0, os.path.join(PROJECT_ROOT, 'apps'))
sys.path.insert(0, os.path.join(PROJECT_ROOT, 'extras'))
sys.path.insert(0, os.path.join(PROJECT_ROOT, 'libs'))
注2:自定義libs的加載,在settings.py中設置:
sys.path.insert(0, '/{{MY_LIB)}/site-packages/*****.egg')
sys.path.insert(0, '/{{MY_LIB}} /site-packages/')
app目錄結構
$APP_NAME/
tests/ app級別的測試代碼
models/ 注1
__init__.py
Amodels.py
Bmodels.py
templates/ 注2
templatetags/ tag目錄
注1:如果很好的控制app的規模,Model類數量少,可以使用慣用的models.py文件中, 否則將models做成一個package
接下來可以有兩種做法:
1. 在__init__.py中import所有的Model類
2. 指定Model的元類(Meta)的app_label, 參考這里
注2:如果extend 工程下的base.html, 使用 !base.html