Skip to main content

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):

  1. Set a shell variable to the version you are releasing (this just makes subsequent steps easier):

    version=X.Y.Z
    
  2. Update setup.cfg so that the version is correct.

  3. Stage the changed files and commit.

    git add -u
    git commit -m v$version -n
    
  4. Push your changes.

    git push
    
  5. When ready, create a signed tag for the release:

    git tag -s v$version
    

    Base the tag message on the changelog.

  6. Push the tag.

    git push origin tag v$version
    
  7. If applicable: Create a release, based on the tag you just pushed, on GitHub or GitLab.

  8. 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

matrix_common-1.3.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

matrix_common-1.3.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file matrix_common-1.3.0.tar.gz.

File metadata

  • Download URL: matrix_common-1.3.0.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for matrix_common-1.3.0.tar.gz
Algorithm Hash digest
SHA256 62e121cccd9f243417b57ec37a76dc44aeb198a7a5c67afd6b8275992ff2abd1
MD5 f040411aea5f393cb8242ee12c8a59c5
BLAKE2b-256 b9caa5e92bc5f01374fadc56e2249f876d70c6b60798c73d3d5c889709691b14

See more details on using hashes here.

File details

Details for the file matrix_common-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for matrix_common-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 524e2785b9b03be4d15f3a8a6b857c5b6af68791ffb1b9918f0ad299abc4db20
MD5 ea895cb4efed0ff749612396efa15159
BLAKE2b-256 c3fd02b073aa6f5d99f4188d590f7bbfaf4bb1e64215dab9ce83747c3da26c15

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page