設計軟體目錄結構，就和「**程式設計風格一樣」，屬於個人風格問題。對於這種風格問題，一直都存在兩種態度：
1.一類同學認為，這種個人風格問題"無關緊要"，只要讓程式work就行，風格問題根本就不是問題。
2.另外一類同學認為，規範化能更好的控制程式結構，讓程式具有更高的可讀性。
大部分人都是傾向於後者的，因為大家都是前一類指導思想下的直接受害者。舉個最簡單的例子，我曾經維護過乙個很不好讀的專案，其實實現邏輯並不是很複雜，但卻耗費了我非常長的時間去理解它所表達的意思。從此，我對於專案的可讀性、可維護性的要求就提高了。專案目錄結構也是屬於"可讀性"和"可維護性"的範疇，我們設定乙個層次清晰的目錄結構，就是為了達到兩點要求：
1.可讀性高：不熟悉這個專案**的人，一眼就能夠看懂目錄結構，知道程式啟動指令碼是哪個，測試目錄在**，配置檔案在**等等。從而非常快速的了解這個專案。
2.可維護性高：定義好組織規則後，維護者能很明確地知道，新增的哪個檔案和**應該放在哪個目錄下面。這個好處是，隨著時間的推移，**和配置的規模的增加，目錄結構不會混亂，任然能夠組織良好。
所以，我認為保持乙個良好的專案結構目錄是十分有必要的。更何況組織乙個良好的專案組織結構，是一件很容易的事情。
關於如何組織乙個較好的python工程組織結構，已經有一些得到共識的目錄結構。
所以，我在這裡不再贅餘，直接在這裡說一下我的體會和理解：
foo/|-- bin/
| |--foo
||-- foo/
| |-- tests/
| | |-- __init__
.py| | |--test_main.py
| |
| |-- __init__
.py| |--main.py
||-- docs/
| |--conf.py
| |--abc.rst
||--setup.py
|--requirements.txt
|-- readme
在此簡單的解釋一下：
下面講解一下我對軟體目錄的理解和要求吧。
具體請參見文章：
這個我個人覺得這應該是每個專案都應該有的乙個檔案，目的是簡要描述專案資訊，讓讀者快速了解這個專案。
他需要說明以下的幾個事項：
軟體定位，軟體的基本功能
軟體**的方法：安裝環境、啟動命令等。
簡要的使用說明
**目錄結構說明，更詳細點可以說明簡要說明軟體的基本原理
常見問題說明
一般來說，用setup.py來管理，打包、安裝、部署等問題。業界標準的寫法是使用python流行的打包工具setuptools來管理這些事情，這種開源專案普遍應用於開源專案中。不過這裡的核心思想不是用標準化的工具來解決這個問題，而是說乙個專案一定要有乙個安裝部署工具。能夠快速便捷的在一台機器上面將環境裝好， **部署好和將程式執行起來。
以下是實際遇到的一些坑。
我剛開始接觸python寫專案的時候，安裝環境、部署**、執行程式這個過程全部都是手寫的，遇到過以下的問題：
安裝環境時候經常忘記最近新增了乙個新的python包，結果一到線上執行，程式就出錯了。
python包的版本依賴問題，有時候我們程式中使用的是乙個版本的python包，但是官方的已經是最新的包，通過手動安裝就可能裝錯了。
如果依賴的包很多的話，乙個乙個安裝這些依賴的是很費時的事情。
新同學剛開始寫專案的話，將程式爬起來非常麻煩，因為可能經常忘記要這麼安裝各種依賴。
setup.py能夠將這些事情自動化起來， 提高效率，減少出錯的概率。「複雜的東西自動化，能自動化的東西一定要自動化。」是乙個非常好的習慣。
setuptools的文件過於龐大，剛接觸的時候，可能不太好切入，學習技術的方式就是看別人如何用，可以參照一下python的乙個web框架，flask是如何寫的：setup.py
當然，簡單點，自己寫個指令碼（deploy.sh）來代替setup.py也可以。
這個檔案存在的目的是：
方便開發者維護軟體的包依賴。將開發過程中新增的包新增進這個列表中，避免在setup.py安裝依賴書時漏掉軟體包
方便讀者明確專案使用了哪些python包
注意，在上述的目錄結構中，沒有把conf.py放在原始碼目錄下，而是放在docs/目錄下：
很多專案對配置檔案的使用做法是：
配置檔案寫在乙個或多個python檔案中，比如此處的conf.py。
專案中那個模組用到這個配置檔案就直接通過import conf這種形式來在**中使用配置。
這種做法我不太贊同：
這讓單元測試變得困難（因為模組內部依賴了外部配置）
另一方面配置檔案作為使用者控制程式的介面，應當可以由使用者自由指定該檔案的路徑。
程式元件可復用性太差，因為這種貫穿所有模組的**硬編碼方式，是的大部分**都依賴於conf.py這個文件。
所以，我認為配置的使用，更好的方式是，
模組的配置都是可以靈活配置的，不受外部配置檔案的影響。
程式的配置也是可以靈活控制的。
能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程式都可以自由的指定使用者配置
所以，不應當在**中直接import conf來使用配置檔案。上面目錄結構中的conf.py，是給出的乙個配置樣例，不是在寫死在程式中直接引用的配置檔案。可以通過給main.py啟動引數指定配置路徑的方式來讓程式讀取配置內容。當然，這裡的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫配置檔案，比如settings.yaml之類的。
Python模組的匯入以及軟體開發規範
1 當指令碼直接使用，直接當指令碼執行呼叫即可 def func print from func1 func 2 當做模組被匯入使用，但是又想測試當前指令碼是否能正常執行就是用ifname main def func print from func1 if name main func 我們在建立包...
軟體開發目錄規範
為了提高程式的可讀性與可維護性，我們應該為軟體設計良好的目錄結構，這與規範的編碼風格同等重要，簡而言之就是把軟體 分檔案目錄。假設你要寫乙個atm軟體，你可以按照下面的目錄結構管理你的軟體 atm core src.py 業務核心邏輯 api api.py 介面檔案 db db handle.py ...
軟體開發目錄規範
為了提高程式的可讀性與可維護性，我們應該為軟體設計良好的目錄結構，這與規範的編碼風格同等重要。軟體的目錄規範並無硬性標準，只要清晰可讀即可，假設你的軟體名為foo，筆者推薦目錄結構如下 foo core 存放業務邏輯相關 core.py api 存放介面檔案，介面主要用於為業務邏輯提供資料操作。ap...