每個真正的程序員,可能都會夢想著能夠發(fā)布開源項目,讓自己的代碼被別人所用。開源項目會發(fā)布到開發(fā)的版本管理系統(tǒng)(比如GitHub)上面,為了讓大家能夠方便使用你的代碼,項目的目錄結(jié)構(gòu)應該遵循一定的規(guī)范。即使不是開源項目,項目目錄結(jié)構(gòu)符合一定的規(guī)范對你的項目管理也是有好處的。
下面列出python開源項目的通常目錄結(jié)構(gòu)及說明:
.tx/ 如果你使用Transifex進行國際化的翻譯工作,創(chuàng)建此目錄
config Transifex的配置文件
$PROJ_NAME/ 按照你實際的項目名稱創(chuàng)建目錄。如果有多個子項目,就創(chuàng)建多個目錄
docs/ 項目文檔
wiki/ 如果有wiki,可以創(chuàng)建此目錄
scripts/ 項目用到的各種腳本
tests/ 測試代碼
extras/ 擴展,不屬于項目必需的部分,但是與項目相關(guān)的sample、poc等,下面給出4個例子:
dev_example/
production_example/
test1_poc/
test2_poc/
.gitignore 版本控制文件,現(xiàn)在git比較流行
AUTHORS 作者清單
INSTALL 安裝說明
LICENSE 版權(quán)聲明
MANIFEST.in 裝箱清單文件
MAKEFILE 編譯腳本
README 項目說明文件,其他需要的目錄下也可以放一個README文件,說明該目錄的內(nèi)容
setup.py python模塊的安裝腳本
這個目錄結(jié)構(gòu)是針對python項目的,各種語言習慣的目錄結(jié)構(gòu)可能不同,但一些基本的要素還是共同的,可以舉一反三。
本人已在github上用Jekyll建立了新的博客:http:///,本站文章會陸續(xù)遷移過去
|