Python軟體目錄結構

標籤：檔案   rip   原始碼   方式   體會   flow   外部   方便   require   

　　

目錄組織方式

關於如何組織一個較好的Python工程目錄結構，已經有一些得到了共識的目錄結構。在Stackoverflow的這個問題上，能看到大家對Python目錄結構的討論。

這裡面說的已經很好了，我也不打算重新造輪子列舉各種不同的方式，這裡面我說一下我的理解和體會。

假設你的項目名為foo, 我比較建議的最方便快捷目錄結構這樣就足夠了:

Foo/|-- bin/|   |-- foo||-- foo/|   |-- tests/|   |   |-- __init__.py|   |   |-- test_main.py|   ||   |-- __init__.py|   |-- main.py||-- docs/|   |-- conf.py|   |-- abc.rst||-- setup.py|-- requirements.txt|-- README

簡要解釋一下:

1. bin/: 存放項目的一些可執行檔，當然你可以起名script/之類的也行。
2. foo/: 存放項目的所有原始碼。(1) 原始碼中的所有模組、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄tests/存放單元測試代碼； (3) 程式的入口最好命名為main.py。
3. docs/: 存放一些文檔。
4. setup.py: 安裝、部署、打包的指令碼。
5. requirements.txt: 存放軟體依賴的外部Python包列表。
6. README: 項目說明檔案。

Python軟體目錄結構