Common utilities for Synapse, Sydent and Sygnal.
pip install matrix-common
import matrix_common
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.
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 the version 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*
FAQs
Common utilities for Synapse, Sydent and Sygnal
We found that matrix-common demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.