README的最后部分是关于如果你想通过代码贡献来参与其中。

开发安装

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

git clone git+https://github.com/cthoyt/biotools-client.git
cd biotools-client
pip install -e .

更新包模板

本项目使用cruft来确保模板（即配置、贡献指南、文档配置）与上游cookiecutter包保持最新。更新方法如下

pip install cruft
cruft update

有关Cruft更新命令的更多信息，请参阅这里。

🥼 测试

在克隆仓库并使用pip install tox tox-uv安装tox后，可以在tests/文件夹中可重复地运行单元测试。

tox -e py

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

📖 构建文档

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

git clone git+https://github.com/cthoyt/biotools-client.git
cd biotools-client
tox -e docs
open docs/build/html/index.html

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

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

配置ReadTheDocs

1. 使用GitHub账户登录ReadTheDocs，然后在https://readthedocs.org/accounts/login/?next=/dashboard/安装集成。
2. 通过导航到https://readthedocs.org/dashboard/import并点击您仓库旁边的加号图标导入您的项目。
3. 在下一屏上，您可以使用更时尚的名称（例如，包含空格和大小写字母）重命名仓库。
4. 点击下一步，然后您就设置好了！

📦 发布版本

配置Zenodo

Zenodo是一个长期存档系统，为每个包的每个版本分配一个DOI。

1. 通过以下链接使用GitHub登录Zenodo：https://zenodo.org/oauth/login/github/?next=%2F。这会带您到一个列出您所有组织的页面，并要求您批准在GitHub上安装Zenodo应用。点击您想要启用集成的任何组织旁边的“授权”，然后点击大的绿色“批准”按钮。此步骤只需执行一次。
2. 导航至https://zenodo.org/account/settings/github/，该页面列出了您的所有GitHub仓库（包括您自己的用户名和您启用的任何组织）。点击任何相关仓库的开关。

完成这些步骤后，您就可以开始了！在GitHub上进行“发布”操作（具体步骤见下文）后，您可以导航至https://zenodo.org/account/settings/github/repository/cthoyt/biotools-client，查看发布版本的DOI并链接到Zenodo记录。

在Python包索引（PyPI）注册

您只需要完成以下步骤一次。

1. 在Python包索引（PyPI）注册账户
2. 导航至https://pypi.ac.cn/manage/account并确保您已验证了电子邮件地址。默认情况下可能没有发送验证邮件，因此您可能需要点击地址旁边的“选项”下拉菜单来获取“重新发送验证邮件”按钮。
3. 自2023年底以来，PyPI要求进行两步验证（见此PyPI博客文章）。这意味着您必须首先生成账户恢复代码，然后设置两步验证。
4. 从https://pypi.ac.cn/manage/account/token发出API令牌

配置您的机器连接到PyPI

您必须为每台机器执行以下步骤一次。在您的家目录中创建一个名为.pypirc的文件，并包含以下内容

[distutils]
index-servers =
    pypi
    testpypi

[pypi]
username = __token__
password = <the API token you just got>

# This block is optional in case you want to be able to make test releases to the Test PyPI server
[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = <an API token from test PyPI>

请注意，由于PyPI要求基于令牌的验证，我们直接使用__token__作为用户。如果您已经有一个包含[distutils]部分的.pypirc文件，只需确保存在index-servers键并且pypi在其关联列表中。有关配置.pypirc文件的更多信息，请参阅此处。

上传到PyPI

在开发模式下安装包并使用pip install tox tox-uv安装tox后，从shell中运行以下命令

tox -e finish

此脚本执行以下操作

1. 使用Bump2Version将pyproject.toml、CITATION.cff、src/biotools_client/version.py和docs/source/conf.py中的版本号更改为不带-dev后缀
2. 使用build将代码打包成tar存档和wheel
3. 使用twine上传到PyPI。
4. 将代码推送到GitHub。您需要创建一个带有版本号更新的提交的发布。
5. 将版本号提升到下一个补丁。如果您进行了重大更改并希望通过次要版本提升版本号，可以使用tox -e bumpversion -- minor。

在GitHub上发布

1. 导航至https://github.com/cthoyt/biotools-client/releases/new来起草一个新的发布
2. 点击“选择一个标签”下拉菜单，并选择与您刚刚制作的发布对应的标签
3. 点击“生成发布说明”按钮以获取最近更改的快速概要。根据需要修改标题和描述
4. 点击大的绿色“发布发布”按钮

这将触发Zenodo为您的发布分配DOI。