Matrix Content Scanner
A web service for scanning media hosted by a Matrix media repository
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
To run the linters and
mypy type checker, use
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):
setup.cfgso that the
Stage the changed files and commit.
git add -u git commit -m v$version -n
Push your changes.
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_content_scanner-$version*