Common utilities for Synapse, Sydent and Sygnal
Project description
matrix-python-common
Common utilities for Synapse, Sydent and Sygnal.
Installation
pip install matrix-common
Usage
import matrix_common
Development
In a virtual environment with pip ≥ 21.1, run
pip install -e .[dev]
To run the unit tests, you can either use:
tox -e py
or
trial tests
To run the linters and mypy
type checker, use ./scripts-dev/lint.sh
.
Releasing
The exact steps for releasing will vary; but this is an approach taken by the Synapse developers (assuming a Unix-like shell):
-
Set a shell variable to the version you are releasing (this just makes subsequent steps easier):
version=X.Y.Z
-
Update
setup.cfg
so that theversion
is correct. -
Stage the changed files and commit.
git add -u git commit -m v$version -n
-
Push your changes.
git push
-
When ready, create a signed tag for the release:
git tag -s v$version
Base the tag message on the changelog.
-
Push the tag.
git push origin tag v$version
-
If applicable: Create a release, based on the tag you just pushed, on GitHub or GitLab.
-
If applicable: Create a source distribution and upload it to PyPI:
python -m build twine upload dist/matrix_common-$version*
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for matrix_common-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afd1a9f63388a8c36165e0366417cb9805666cf1fd7f6b15b5d1c1bad5ceb6ab |
|
MD5 | 23a4164f4ab55bce3de1e00c7aa5071f |
|
BLAKE2b-256 | fee4f2baf69fdb6a8fc5197089e63400cfe2a3338c92f31c1867e0fae1678e73 |