"Synapse module to automatically accept invites"
Project description
Auto-accept invites
Synapse module to automatically accept invites.
Compatible with Synapse v1.47.0 and later.
Installation
From the virtual environment that you use for Synapse, install this module with:
pip install synapse-auto-accept-invite
(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_auto_accept_invite.InviteAutoAccepter
config:
# Optional: if set to true, then only invites for direct messages (1:1 rooms)
# will be auto accepted. Otherwise, all room invites are accepted.
# Defaults to false.
accept_invites_only_for_direct_messages: false
# (For workerised Synapse deployments)
# If you want to accept invites on a specific worker, specify its instance
# name here. Otherwise, invites will be processed on the main process.
#
# Any worker can be used.
#
#worker_to_run_on: workername1
A note about logging
Your Synapse logging configuration should have the following option set in it:
disable_existing_loggers: False
Without it, logging from this module (and potentially others) may not appear in your logs.
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
-
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
-
Create a source distribution and upload it to PyPI:
python -m build twine upload dist/synapse_auto_accept_invite-$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 synapse_auto_accept_invite-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 171d4cf027ad43e1c09f91116a9ca39e3b1a555606a1ff541d70f6656966d2a9 |
|
MD5 | 0095300d0afbb163f1127fb7f28a4f75 |
|
BLAKE2b-256 | 9b406de6df863659b5de50cd0254a6bb68c75248939cb149e8c6c8747175daf8 |
Hashes for synapse_auto_accept_invite-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a196b4f6245a826de65dde6591488262675d7ba5ac4ce11692c507051b30a58e |
|
MD5 | 987a8616ae16ca2fb2eb7828204785a5 |
|
BLAKE2b-256 | f6b1870cf00d64df897c7a711c6d006ffd2707e4a2290cc4cc55555e084ccf49 |