在設計大型項目時需要規范目錄結構。
假設你的項目名為foo, 我比較建議的最方便快捷目錄結構這樣就足夠了:
Foo/
|-- bin/ | |-- foo | |-- foo/ | |-- tests/ | | |-- __init__.py | | |-- test_main.py | | | |-- __init__.py | |-- main.py | |-- docs/ | |-- conf.py | |-- abc.rst | |-- setup.py |-- requirements.txt |-- README 簡要解釋一下:
bin/: 存放項目的一些可執行文件，當然你可以起名script/之類的也行。foo/: 存放項目的所有源代碼。(1) 源代碼中的所有模塊、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄tests/存放單元測試代碼； (3) 程序的入口最好命名為main.py。docs/: 存放一些文檔。setup.py: 安裝、部署、打包的腳本。requirements.txt: 存放軟件依賴的外部Python包列表。README: 項目說明文件。
除此之外，有一些方案給出了更加多的內容。比如LICENSE.txt,ChangeLog.txt文件等，我沒有列在這里，因為這些東西主要是項目開源的時候需要用到。如果你想寫一個開源軟件，目錄該如何組織，可以參考這篇文章。
下面，再簡單講一下我對這些目錄的理解和個人要求吧。
關於README的內容
這個我覺得是每個項目都應該有的一個文件，目的是能簡要描述該項目的信息，讓讀者快速了解這個項目。
它需要說明以下幾個事項:
- 軟件定位，軟件的基本功能。
- 運行代碼的方法: 安裝環境、啟動命令等。
- 簡要的使用說明。
- 代碼目錄結構說明，更詳細點可以說明軟件的基本原理。
- 常見問題說明。
我覺得有以上幾點是比較好的一個README。在軟件開發初期，由於開發過程中以上內容可能不明確或者發生變化，並不是一定要在一開始就將所有信息都補全。但是在項目完結的時候，是需要撰寫這樣的一個文檔的。
可以參考Redis源碼中Readme的寫法，這里面簡潔但是清晰的描述了Redis功能和源碼結構。
關於requirements.txt和setup.py
setup.py
一般來說，用setup.py來管理代碼的打包、安裝、部署問題。業界標准的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源項目中。不過這里的核心思想不是用標准化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一台新機器上將環境裝好、代碼部署好和將程序運行起來。
這個我是踩過坑的。
我剛開始接觸Python寫項目的時候，安裝環境、部署代碼、運行程序這個過程全是手動完成，遇到過以下問題:
- 安裝環境時經常忘了最近又添加了一個新的Python包，結果一到線上運行，程序就出錯了。
- Python包的版本依賴問題，有時候我們程序中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。
- 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。
- 新同學開始寫項目的時候，將程序跑起來非常麻煩，因為可能經常忘了要怎么安裝各種依賴。
setup.py可以將這些事情自動化起來，提高效率、減少出錯的概率。"復雜的東西自動化，能自動化的東西一定要自動化。"是一個非常好的習慣。
setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎么用的，可以參考一下Python的一個Web框架，flask是如何寫的: setup.py
當然，簡單點自己寫個安裝腳本（deploy.sh）替代setup.py也未嘗不可。
requirements.txt
這個文件存在的目的是:
- 方便開發者維護軟件的包依賴。將開發過程中新增的包添加進這個列表中，避免在
setup.py安裝依賴時漏掉軟件包。 - 方便讀者明確項目使用了哪些Python包。
這個文件的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了。具體格式說明： 點這里。
轉載於https://www.cnblogs.com/alex3714/articles/5765046.html
這邊我創建了一個項目，有bin、conf、core、logs目錄。在每個目錄下都加上__init__.py，是文件夾變成包，可以使用import導入包。
/core/main.py代碼：
def login():
print("Welcome Login Page")
/bin/dowork.py代碼：
from core import main main.login()
運行結果
Welcome Login Page
獲取程序目錄
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) print(BASE_DIR) sys.path.append(BASE_DIR)