Python Boilerplate (python_boilerplate)

这是一个测试仓库。

文档

有关更详细的说明，请参阅我们的 文档。

安装

要安装python_boilerplate（在线索引为bryn_python_boilerplate），我们建议使用mamba包管理器

作为用户

mamba create -n python_boilerplate -c conda-forge -c brynpickering bryn_python_boilerplate
mamba activate python_boilerplate

作为开发者

git clone git@github.com:brynpickering/python_boilerplate.git
cd python_boilerplate
mamba create -n python_boilerplate -c conda-forge --file requirements/base.txt --file requirements/dev.txt
mamba activate python_boilerplate
pip install --no-deps -e .

有关更详细的说明，请参阅我们的 文档。

贡献

有许多方式可以为python_boilerplate做出贡献。在向python_boilerplate源代码做出贡献之前，请参阅我们的贡献指南并遵循开发安装说明。

如果您计划修改代码，那么请在工作期间定期使用以下工具来验证代码库

• pre-commit：在命令行中运行pre-commit install以加载内置的检查，这些检查将在您提交更改时运行。检查包括：1. 检查是否有大文件被暂存，2. 对Python文件进行代码审查以查找主要错误，3. 格式化Python文件以符合pep8标准。您也可以在任何时候自行运行这些检查，以确保暂存更改是干净的，只需简单地调用pre-commit。
• pytest - 运行单元测试套件并检查测试覆盖率。
• pytest -p memray -m "high_mem" --no-cov (Windows上不可用) - 安装 memray 后 (mamba install memray pytest-memray)，测试内存和时间性能不超过基准。

更多信息，请参阅我们的 文档。

构建文档

如果您无法访问在线文档，您可以在本地构建文档。首先，安装 python_boilerplate 的开发环境，然后使用 mike 部署文档

mike deploy develop
mike serve

然后您可以在浏览器中查看文档，地址为 https://:8000/。

致谢

本包是用 Cookiecutter 和 arup-group/cookiecutter-pypackage 项目模板创建的。