一、簡介
這裡介紹進行python項目開發時,項目的目錄結構和相關文件編寫。這裡的相關文件主要指requirements.txt文件和README.md文件。
這是小編準備的python基礎學習資料,關注,轉發,私信小編“01”即可免費領取!
![python項目結構及相關文件編寫](http://p2.ttnews.xyz/loading.gif)
二、python項目結構
1、python項目組合部分
python項目主要包括以下幾部分:
bin: 可執行文件;
docs: 項目文檔;
項目名: 這裡就是具體的項目代碼;
tests: 測試代碼;
README.md: 項目介紹;
requirements.txt: python項目依賴包定義;
2、結構示意如下:
![python項目結構及相關文件編寫](http://p2.ttnews.xyz/loading.gif)
三、requirements.txt文件
requirements.txt是定義項目依賴的python包,可通過工具生成。工具可以生成兩種依賴包定義,
一是項目依賴的python包,二是所在python環境安裝的python包。
1、生成項目依賴包步驟
a、安裝pipreqs工具,命令:sudo pip3 install pipreqs
b、到項目根目錄下,命令: pipreqs ./
這時就會生成requirements.txt文件
2、生成整個當前python環境安裝的python包
到項目根目錄下,直接運行:pip3 freeze > requirements.txt
3、requirements.txt安裝
命令:pip3 install -r requirements.txt
四、README.md文件
README.md文件用於介紹項目內容和使用。編寫遵守一定語法,下面進行簡要介紹。
1、多個=或-來標識標題
a、在文字下一行,編寫多個=,可標識大標題;
a、在文字下一行,編寫多個,可標識中標題;
如:
效果:
2、多個#標識不同級別的標題
#個數從1到6個,分別標識6個級別的標題,如:
效果:
3、列表
多個*和空格標識簡單列表,如:
數據加空格標識有序列表,如:
效果:
4、多個>標識不同級別的縮進
如:
效果:
5、通過
或者行末加兩個空格標識換行
如:
效果:
6、通過` `或** **標識文字強調
<code>簡單`強調`
加粗**字體**/<code>
效果:
7、添加文字鏈接或添加圖片
通過[]()來標識文字鏈接,通知![]()添加圖片,如:
簡單[鏈接](https://pypi.org/project/readme-md/)
圖片顯示![pic](https://ss0.bdstatic.com/70cFvHSh_Q1YnxGkpoWK1HF6hhy/it/u=252090772,886630676&fm=26&gp=0.jpg)
效果:
8、代碼或區域標識
通過``` ```進行區域標識,同時可指定代碼類型,如:
效果:
9、完整示例如下:
閱讀更多 python編程那些事 的文章