python：軟件目錄結構規范

為什么要設計好目錄結構？

“設計項目目錄結構”，就和“代碼編碼風格”一樣，屬于個人風格問題。對于這種風格上的規范，一直都存在兩種態度：

　　1.一種認為，這種個人風格問題“無關緊要”。理由是能讓程序work就好，風格問題根本不是問題。

　　2.另一種認為，規范化能更好地控制程序結構，讓程序具有更高的可讀性。

個人傾向于后者。“項目目錄結構”其實也是屬于“可讀性和可維護性”的范疇，我們設計一個層次清晰的目錄結構，就是為了達到以下兩點：

　　1.可讀性高：不熟悉這個項目的代碼的人，一眼就能看懂目錄結構，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非常快速的了解這個項目。

　　2.可維護性高：定義好組織規則后，維護者就能很明確地知道，新增的哪個文件和代碼應該放在什么目錄之下。這個好處是，隨著時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好

故而，保持一個層次清晰的目錄結構是有必要的。更何況組織一個良好的工程目錄，其實是一件很簡單的事兒。

?

目錄組織方式：

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

如：假設你的項目名為foo，個人建議的最方便快捷目錄結構這樣就足夠了

Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|   |-- 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：項目說明文件
除此之外，有一些方案給出了更加多的內容。比如LIENSE.txt,ChangeLog.txt文件等(這里沒有列出，是因為這些東西在項目開源時才用得到)

關于README的內容
這個文件，個人覺得是每個項目都該有的一個文件，目的是能簡要描述項目的信息，讓讀者快速了解這個項目。
它主要說明以下幾個事項:
    1.軟件定位，軟件的基本功能。
    2.運行代碼的方法:安裝環境、啟動命令等。
    3.簡要的使用說明。
    4.代碼目錄結構說明，更詳細點可以說明軟件的基本原理。
    5.常見問題說明。

?