目錄組織方式
假設專案名為foo，建議方便快捷的目錄結構如下：
foo/
| - - bin/
| | - - foo
|| - - foo/
| | - - tests/
| | | - - __init__.py
| | | - - test_main.py
| |
| | - - __init__.py
| | - - __main.py
|| - - docs/
| | - - conf.py
| | - - abc.rst
|| - - setup.py
| - - requirements.text
| - - readme
簡要解釋：
1、bin/：存放專案的一些可執行檔案，當然也可以起名script/之類的也行。
2、foo/：存放專案所有源**。（1）源**中的所有模組、包都應該放在此目錄。不要置於頂層目錄。（2）其子目錄tests/存放單元測試**；（3）程式的入口最好命名為main.py。
3、docs/：存放一些文件
4、setup.py:安裝、部署、打包的指令碼。
5、requirements.txt：存放軟體依賴的外部python包列表。
6、readme：專案說明檔案。
除此之外，有些方案給出了更加多的內容。比如
license.txt,changelog.txt等檔案，這些東西主要是專案開源的時候要用到。開源專案檔案說明：
關於readme內容
目的是能簡要描述該項目的資訊，讓讀者快速了解這個專案。
他需要說明一下幾個事項：
1、軟體定位，軟體的基本功能。
2、執行**的方法：安裝環境、啟動命令等。
3、簡要的使用說明。
4、**目錄結構說明，更詳細點可以說明軟體的基本原理。
5、常見問題說明。
在軟體開發初期，由於開發過程中以上內容可能不明確或者發生變化，並不是一定要在一開始就將所有資訊寫全。但在專案完結的時候，是需要撰寫這樣的乙個文件。
關於requirements.txt和setup.py
setup.py
一般來說，用setup.py來管理**的打包、安裝、部署問題。業界標準的寫法是用python流行的打包工具stepstools來管理這些事情。這種方式普遍應用於開源專案中。不過這裡的核心思想不是用標準化的工具來解決這些問題，而是說，乙個專案一定要有乙個安裝部署工具，能快速便捷的在一台新機器上將環境安裝好、**部署好和將程式執行起來。
bugs1：
1、安裝環境時經常忘記最近又新增了乙個新的python包，結果一到線上執行程式就出錯。
2、python包的版本依賴問題，有時候程式中使用的是乙個版本的python，但官方的已經是最新的包了，通過手動安裝就可能安裝錯了。
3、如果依賴的包很多的話，乙個乙個安裝這些依賴是很費時的事情。
4、新手開始寫專案的時候，將程式跑起來非常麻煩，因為可能經常忘了要怎麼安裝各種依賴。
setup.py可以將這些事情自動化起來，提高效率、減少出錯的概率。「複雜的東西自動化，能自動化的東西一定要自動化。」是個非常好的習慣。
stepstools的文件比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎麼用的，可以參考一下python的乙個web框架，flask是如何寫的setup.py
requirements.txt
這個檔案存在的目的：
1、方便開發者維護軟體包的依賴。將開發過程中新新增進這個列表中，避免在setup.py安裝依賴時漏掉軟體包。
2、方便讀者明確專案使用了那些python包。
這個檔案的格式是每一行包含乙個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣可以簡單的通過pip install -r requirements.txt來把所有python 包依賴都安裝好。
關於配置檔案的使用方法
注意，在上面的目錄結構中，沒有將conf.py放在源**目錄下，而是放在docs/目錄下。
很多專案的配置方法如下：
1、配置檔案寫在乙個或多個python檔案中，比如此處的conf.py。
2、專案中哪個模組用到這個配置檔案就直接通過import conf這種形式來在**中使用配置。
這種方法的弊端：
1、這讓單元測試變的困難（因為模組內部依賴了外部配置）
2、另一方面配置檔案作為使用者控制程式的介面，應當可以由使用者自由指定該檔案的路徑。
3、程式元件可復用性太差，因為貫穿所有模組的**硬編碼方式，使得大部分模組都依賴conf.py這個檔案。
所以配置的使用，更好的方式是：
1、模組的配置都是可以靈活配置的，不受外部配置檔案的影響。
2、程式的配置也是可以靈活控制的。
能夠佐證這個思想的是，用過nginx和mysql的人都知道nginx 、mysql這些程式都可以自由的指定使用者配置。
所以，不應當在**中直接import conf來使用配置檔案。上面目錄結構中的conf.py，也是給出的乙個配置樣例，不是在寫死在程式中直接引用的配置檔案。可以通過給main.py啟動引數指定配置路徑的方式讓程式讀取配置內容。當然，這裡的cong.py可以換個型別的名字，比如settings.py。或者也可以使用其他格式的內容來編寫配置檔案，比如settings.yaml之類的。
軟體目錄結構規範
金角大王 為什麼要設計好目錄結構?設計專案目錄結構 就和 編碼風格 一樣，屬於個人風格問題。對於這種風格上的規範，一直都存在兩種態度 一類同學認為，這種個人風格問題 無關緊要 理由是能讓程式work就好，風格問題根本不是問題。另一類同學認為，規範化能更好的控制程式結構，讓程式具有更高的可讀性。我是比...
軟體目錄結構規範
專案目錄結構 是屬於 可讀性和可維護性 的範疇，我們設計乙個層次清晰的目錄結構，就是為了達到以下兩點 所以，保持乙個層次清晰的目錄結構是有必要的。更何況組織乙個良好的工程目錄，其實是一件很簡單的事兒。關於如何組織乙個較好的python工程目錄結構，已經有一些得到了共識的目錄結構。在stackover...
軟體目錄結構規範
一 前言 無規矩不成方圓，乙個規範化的目錄結構，能夠讓程式就有更高的可讀性。如果是乙個生產專案的話，良好的 風格和目錄結 構，能夠極大提高專案的可維護性 畢竟乙個專案不是用一次就不用了 總而言之，我們設計乙個層次清晰的目錄結構，就是 為了達到下面的兩個目的 可讀性高 不熟悉這個專案的人，一眼就能看懂...