1.為什麼要設計好目錄結構

 "專案目錄結構"其實也是屬於"可讀性和可維護性"的範疇，我們設計一個層次清晰的目錄結構，就是為了達到以下兩點:

        （1）可讀性高: 不熟悉這個專案的程式碼的人，一眼就能看懂目錄結構，知道程式啟動指令碼是哪個，測試目錄在哪兒，配 置檔案在哪兒等等。從而非常快速的瞭解這個專案。

        （2）可維護性高: 定義好組織規則後，維護者就能很明確地知道，新增的哪個檔案和程式碼應該放在什麼目錄之下。這個好處是，隨著時間的推移，程式碼/配置的規模增加，專案結構不會混亂，仍然能夠組織良好。

2.目錄組織方式

假設你的專案名為foo，比較建議的最方便快捷目錄結構如下:

Foo/                       # 專案名稱
| - bin/                    ---# 可執行檔案目錄
|   | - foo                 -------# 執行程式（呼叫main.py）
|
| - core/                   ---# 主程式包（包）
|   | - tests/              -------# 測試包（包）
|   |   | - __init__.py
|   |   | - test_main.py
|   |
|   | - __init__.py         -------# 空檔案：有，則為包；無，則為目錄
|   | - main.py             -------# 主程式入口
|
| - docs/                   ---# 配置文件
|   | - conf.py
|   | - abc.rst
|
| - logs/
|
| - setup.py                ---# 安裝、部署、打包的指令碼
| - requirements.txt        ---# 外部依賴關係
| - README 
 

具體目錄及檔案解釋如下：

1. bin/: 存放專案的一些可執行檔案。

2. foo/: 存放專案的所有原始碼。(1) 原始碼中的所有模組、包都應該放在此目錄。不要置於頂層目錄。

                                                     (2) 其子目錄tests/

存放單元測試程式碼

                                                     (3)程式的入口最好命名為main.py

3. docs/: 存放一些文件。

4. setup.py: 安裝、部署、打包的指令碼。

5. requirements.txt: 存放軟體依賴的外部Python包列表。

6. README: 專案說明檔案

7. log: 存放日誌

3.關於配置檔案的使用方法

        不應當在程式碼中直接import conf來使用配置檔案。上面目錄結構中的conf.py，是給出的一個配置樣例，不是在寫死在程式中直接引用的配置檔案。可以通過給main.py啟動引數指定配置路徑的方式來讓程式讀取配置內容。當然，這裡的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫配置檔案，比如settings.yaml之類的。

4.關於setup.py

        一般來說，用setup.py來管理程式碼的打包、安裝、部署問題。業界標準的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源專案中。不過這裡的核心思想不是用標準化的工具來解決這些問題，而是說，一個專案一定要有一個安裝部署工具，能快速便捷的在一臺新機器上將環境裝好、程式碼部署好和將程式執行起來。

        剛開始接觸Python寫專案的新手，安裝環境、部署程式碼、執行程式這個過程全是手動完成，遇到過以下問題:（1）安裝環境時經常忘了最近又添加了一個新的Python包，結果一到線上執行，程式就出錯了。（2）Python包的版本依賴問題，有時候我們程式中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。（3）如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。

   setup.py可以將這些事情自動化起來，提高效率、減少出錯的概率。"複雜的東西自動化，能自動化的東西一定要自動化。"是一個非常好的習慣。

        setuptools的文件比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎麼用的，可以參考一下Python的一個Web框架，flask是如何寫的: setup.py。當然，簡單點自己寫個安裝指令碼（deploy.sh）替代setup.py也未嘗不可。

5.關於requirements.txt

這個檔案存在的目的是:

        （1）方便開發者維護軟體的包依賴。將開發過程中新增的包新增進這個列表中，避免在setup.py安裝依賴時漏掉軟體包。（2）方便讀者明確專案使用了哪些Python包。

        這個檔案的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了。

6.關於README

它需要說明以下幾個事項:

        （1）軟體定位，軟體的基本功能。（2）執行程式碼的方法: 安裝環境、啟動命令等。（3）簡要的使用說明。（4）程式碼目錄結構說明，更詳細點可以說明軟體的基本原理。（5）常見問題說明。

        我覺得有以上幾點是比較好的一個README。在軟體開發初期，由於開發過程中以上內容可能不明確或者發生變化，並不是一定要在一開始就將所有資訊都補全。但是在專案完結的時候，是需要撰寫這樣的一個文件的。