12.3目錄結構

目錄結構

設計好目錄結構

1. 可讀性高
2. 可維護性高

比如一個Foo項目 Foo/	--- bin/		--- foo
--- foo/
	--- tests/
		--- _init__.py
		--- test_main.py
	--- init.py
	--- main.py
---doc
	--- conf.py
	---abc.rst
--- setup.py
--- requirement.txt
--- README

簡要解釋一下：

1. bin/:存放項目的一些可執行文件，當然你可以起名script/之類的也行
2. foo/:存放項目的所有源代碼(1)源代碼中額所有模塊，包都應該放在這個目錄，不要置於頂層目錄。(2)其子目錄tests/存放單元測試的代碼。(3)程序的入口最好命名爲main.py
3. docs/:存放一些文檔
4. setup.py：安裝、部署、打包的腳本
5. requirements.txt:存放軟件依賴的外部python包列表
6. README:項目說明文件
   README內容：
7. 軟件定位，軟件的基本功能
8. 運行代碼的方法，安裝環境，啓動命令等
9. 簡要的使用說明
10. 代碼目錄結構說明，更詳細點可以說明軟件的基本原理
11. 常見問題說明