贡献

测试简单更改

Requests-OAuthlib 使用 tox 作为主要的测试工具。它有助于为你的 Python 版本创建所需的 virtualenv。例如,如果你已安装 Python3.8

$ tox -e py38

验证文档更改

Tox 还包含一个构建方法,用于在本地生成文档。

$ tox -e docs,readme

然后在 _build/html/index.html 中打开 HTML 页面

验证所有 Python 版本

Requests-OAuthlib 支持多个版本的 Python。你可以使用 tox 方便地测试所有 Python 版本。

$ tox

为了成功运行,你需要安装所有版本的 Python。我们建议使用 pyenv 来安装这些 Python 版本。

$ pyenv install 3.8.18
$ pyenv install pypy3.10-7.3.13
$ pyenv global pypy3.10-7.3.13  # switch to pypy

通过管道构建和测试

如果你不想安装多个 Python 版本,或者如果你已在管道代码中进行了更改,则可以使用此处提供的 act 工具在本地执行 Github Action:https://nektosact.com/usage/index.html

pypy3.9 运行测试

`shell act -W .github/workflows/run-tests.yml -j tests --matrix python-version:pypy3.9 `

发布版本(适用于维护者角色)

维护者任务应始终保持在最低限度。一旦版本准备就绪,可以遵循建议的方法

  1. 创建新分支 release-X.Y.Z

  2. 根据需要更新 HISTORY.rst 和 AUTHORS.rst

  3. 更新 request_oauthlib/__init__.py

  4. 提出一个拉取请求,以便在发布前让所有贡献者有机会发表评论

  5. 创建 TAG vX.Y.Z。通过此操作,管道将自动触发 twine,并将版本发布到 PyPi。

验证后,通过执行以下操作完成

  1. 在“版本”标签中创建 GitHub 版本 vX.Y.Z。

  2. 在文档中激活 vX.Y.Z 版本(ReadTheDocs

  3. 将 PR 合并到主分支。

仅此而已。