matrix-python-common

Synapse, Sydent和Sygnal的通用工具。

安装

pip install matrix-common

使用

import matrix_common

开发

在pip ≥ 21.1的虚拟环境中运行

pip install -e .[dev]

要运行单元测试，您可以

tox -e py

或

trial tests

要运行linters和mypy类型检查器，使用./scripts-dev/lint.sh。

发布

发布的确切步骤可能会有所不同；但这是Synapse开发者采取的方法（假设是类Unixshell）

1. 设置一个shell变量以表示您要发布的版本（这仅使后续步骤更容易）

   version=X.Y.Z
   

2. 更新setup.cfg，以便版本正确。

3. 暂存更改的文件并提交。

   git add -u
   git commit -m v$version -n
   

4. 推送您的更改。

   git push
   

5. 准备就绪时，为发布创建一个签名标签

   git tag -s v$version
   

   将标签信息基于变更日志。

6. 推送标签。

   git push origin tag v$version
   

7. 如果适用：根据您刚刚推送的标签在GitHub或GitLab上创建一个发布

8. 如果适用：创建源分发并将其上传到PyPI

   python -m build
   twine upload dist/matrix_common-$version*