- Python 95.8%
- Shell 4.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
This code lives on vector-im, and does therefore belong to New Vector Ltd, not to the Matrix.org Foundation |
||
| .github | ||
| scripts-dev | ||
| tchap_displayname_email | ||
| tests | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| LICENSE | ||
| mypy.ini | ||
| pyproject.toml | ||
| README.md | ||
| setup.cfg | ||
| tox.ini | ||
Tchap display name generator
A Synapse module used by Tchap to derive a display name from a new user's email address.
Installation
From the virtual environment that you use for Synapse, install this module with:
pip install path/to/tchap-displayname-from-email
(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: tchap_displayname_email.TchapDisplaynameEmail
config:
# Whether to try to extract full name and organisation from the email address. The
# resulting display name will have the form "John Doe [Acme]".
# Optional, defaults to "true".
extract_from_email: true
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.cfgso that theversionis 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$versionBase the tag message on the changelog.
-
Push the tag.
git push origin tag v$version