Provides extended support for users to invite other users to rooms via an inventation token
Project description
Super Inivitation flow for Synapse Matrix Homeserver
Provides extended support for users to invite other users to rooms via an invitation token
Installation
From the virtual environment that you use for Synapse, install this module with:
pip install path/to/synapse-super-invites
(If you run into issues, you may need to upgrade pip
first, e.g. by running
pip install --upgrade pip
)
Then alter your homeserver configuration, adding to your modules
configuration:
modules:
- module: synapse_super_invites.SynapseSuperInvites
config:
generate_registration_tokens: true # default: false - whether or not the invite tokens are also usable as registration tokens
enable_web: true # default: false - not yet ready web/html management app
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/synapse_super_invites-$version*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for synapse_super_invites-0.8.0b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9011fb0aee8d0f2fe014a5e2489dfe53de9dddeeaff18faf45b285275f2da8fb |
|
MD5 | 49ca234973d32dd30bc9760a56ff0e13 |
|
BLAKE2b-256 | 4bd166ff7649dffe44c8e3dc1e68302235f59a46d5cefd67198bcdcd2f59ef5c |