pytemplates

我們的項目：項目做什麼

歡迎來到our_project 。

請注意，這是一個模板存儲庫，請單擊使用模板（除非建議改進）在新項目中使用並根據需要編輯文件。另外，請參閱此文件末尾的重要說明。

安裝指南

pip install our_project 

當前實現的功能

our_project當前執行以下操作：

• 包含基類HelloWorld

• HelloWorld具有打印用戶提供的文本的print_text方法。

• 用於測試項目安裝和運行測試的GitHub操作。

• 在PYPI上發布的GitHub動作（需要將PYPI_USERNAME和PYPI_PASSWORD添加到存儲庫秘密。）

需要進一步關注的功能

我們打算將來在以下工作：

• 與sphinx的初始文檔變得不那麼麻煩。

文檔生成

請按要求編輯docs/source/index.rst和docs/source/modules.rst然後運行：

./scripts/mkdocs.sh 

以上假設您是“ our_project”的根。

還刪除setup.rst ， tests.rst ，如果存在。

否則，根據需要運行和編輯。

sphinx-quickstart

謝謝你，

尼爾長22/10/2021

---

重要說明

該存儲庫保存了遵循新python項目的典型工作流程的模板。

謹慎

這些模板主要旨在節省時間。但是，現代IDE提供的項目模板比這裡的模板更成熟，更不明智。

該存儲庫還提供了允許編程新手的開發人員使用非常簡單的示例來研究項目結構的另一個目的。

對於許可，測試和工作流程，Gitignore建議通過Github或Gitlab自動從其選擇的IDE或.gitignore文件和許可證中自動生成這些許可。

很高興在任何問題和/或反饋中收到您的來信。

---

免責聲明：

無論如何，這個項目與類似命名的軟件包pytemplates無關，該軟件包的作用完全不同（“ Pytemplates是用Python編寫的輕質HTML模板引擎，並支持模板繼承，塊，宏，宏，上下文和Django。”）。

在此文件中添加徽章後，我只需要了解此軟件包。