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。”）。

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