README的最后一部分是为那些想通过代码贡献来参与其中的人准备的。

开发安装

要使用开发模式安装，请使用以下命令

git clone git+https://github.com/biopragmatics/semra.git
cd semra
pip install -e .

🥼 测试

在克隆存储库并使用pip install tox安装tox后，可以使用以下命令反复运行tests/文件夹中的单元测试

tox

此外，这些测试会自动在GitHub Action的每次提交中重新运行。

📖 构建文档

可以使用以下命令在本地构建文档

git clone git+https://github.com/biopragmatics/semra.git
cd semra
tox -e docs
open docs/build/html/index.html

文档会自动安装包以及setup.cfg中指定的docs额外内容。sphinx插件如texext可以添加到其中。此外，它们还需要添加到docs/source/conf.py中的extensions列表。

可以使用ReadTheDocs使用本指南将文档部署到。该.readthedocs.yml YAML文件包含您所需的所有配置。您还可以在GitHub上设置持续集成，以检查Sphinx是否可以在隔离环境中构建文档（即，使用tox -e docs-test），以及ReadTheDocs也可以构建它。

📦 制作发布版本

在开发模式下安装包并使用pip install tox安装tox后，制作新版本的命令包含在tox.ini中的finish环境中。请在shell中运行以下命令

tox -e finish

此脚本执行以下操作

1. 使用Bump2Version将setup.cfg、src/semra/version.py和docs/source/conf.py中的版本号切换为不带-dev后缀
2. 使用build将代码打包成tar存档和wheel
3. 使用twine上传到PyPI。请确保已配置.pypirc文件以避免在此步骤中需要手动输入
4. 推送到GitHub。您需要创建一个发布版本，与提升版本的提交相对应
5. 将版本提升到下一个补丁级别。如果您进行了较大的更改并希望通过次要版本提升版本，您可以在之后使用tox -e bumpversion -- minor