新人必看：python自動化辦公，開源專案的目錄結構

大家好，這裡是程式設計師晚楓。 開源專案：python-office 已經上線1個月了，功能一直在不斷完善中。

python-office 是一個 Python 自動化辦公第三方庫，能解決大部分自動化辦公的問題。而且每個功能只需一行程式碼，不需要小白使用者學習 Python 知識，希望做到真正的開箱即用。

今天給大家詳細介紹一下這個開源專案的目錄結構，方便大家對該專案的理解和參與開發，也歡迎大家對目錄結構給出自己的建議，目前的版本主要參考了幾個流行框架的目錄結構：pandas、flask、dash。

功能持續更新中，提交你的功能需求/參與專案開發👉Gitee

目錄總覽

資料夾 PATH 列表
卷序列號為 000000AB 0A45:16TS
D:\PYTHON-OFFICE
├─.idea
├─cli
├─contributors
│  └─demo
├─examples
├─core
├─docs
├─lib
│  ├─image
│  ├─pdf
│  ├─ppt
│  ├─tools
│  └─utils
├─office
├─script
├─tests
└─venv

該專案的原始碼目錄，目前包含：核心程式碼、PR資料夾、文件、單元測試、開發指令碼、虛擬環境。

開源參與者的目錄

開源專案的精髓，在於大家的集體創作。

因為我是第一次組織開源專案，而且專案初創，需要頻繁變動主目錄和程式碼，所以目前採取了一種比較保守的PR方式：

大家把自己的程式碼，在master分支上傳到以自己暱稱命名的資料夾後，由我來將大家的程式碼，加入上文介紹的核心功能目錄中。

未來專案穩定了，會逐步更換為開闢develop分支，並且直接提交到核心目錄的PR方式。

所以目前建立了2個資料夾：

• contributors：在這裡，自己用暱稱新建一個資料夾後，任意修改和提交。不要動別人資料夾下的專案即可。
• examples：同樣用自己暱稱新建一個資料夾，在裡面寫一個對自己開發功能的呼叫，這一步必須有。 

使用者的核心功能目錄

其中使用者會使用到的核心程式碼的資料夾有以下幾個：

這幾個資料夾之間的關係，如下圖所示。

1. 使用者有2種方式呼叫python-office這個庫：

• ①通過在程式碼裡import office，
• ②直接在cmd頁面，執行cli包裡的命令列（功能開發中）。

1. office庫只提供API介面，核心功能類的實現在core資料夾進行開發，core中的通用工具類或者對第三方庫的呼叫，在lib裡進行開發。它們之間之所以是層層呼叫的關係，是為了程式碼的解耦合，使程式碼邏輯更加清晰。 

開發人員用的目錄

這部分目錄是給開發人員使用的，和僅僅使用python-office這個庫的使用者無關。

• tests：單元測試的庫，自己可以選擇使用unittest或者pytest，我目前主要使用了unittest；
• venv：本專案的虛擬環境，按照慣例，該目錄沒有上傳到git倉庫，需要自行配置；
• script：目前主要是打包工具、釋出工具，；
• docs：存放有關專案的說明文件。

寫在最後

通過最近一段時間的開發我發現，參與開源專案的建設，可以快速提高自己的程式設計能力。 期待更多大神，參與到本專案的開發中~

如有任何疑問或建議，請大家在評論區和我交流❤