python開源項目目錄結構參考

每一個真正的程序員，可能都會夢想着可以發佈開源項目，讓本身的代碼被別人所用。開源項目會發布到開發的版本管理系統（好比GitHub）上面，爲了讓你們可以方便使用你的代碼，項目的目錄結構應該遵循必定的規範。即便不是開源項目，項目目錄結構符合必定的規範對你的項目管理也是有好處的。

下面列出python開源項目的一般目錄結構及說明：

.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項目的， 各類語言習慣的目錄結構可能不一樣，但一些基本的要素仍是共同的，能夠觸類旁通。