Python 之 軟體目錄結構規範

標籤：代碼   安裝   com   子目錄   target   結構   模組   app   over   

目錄結構規範 - Stackoverflow.com - project structure

建議的模式

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

Foo/
|-- bin/
|   |-- foo  （主程式目錄，啟動指令碼，調用main）
|
|-- 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 之 軟體目錄結構規範