新人必看:python自動化辦公,開源項目的目錄結構

語言: CN / TW / HK

大家好,這裏是程序員晚楓。 開源項目: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:存放有關項目的説明文檔。

寫在最後

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

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