fosdem22-demo-module's Introduction

Demo Synapse module for FOSDEM 2022

This module is the one developped as part of the talk on Synapse modules during FOSDEM 2022.

Installation

From the virtual environment that you use for Synapse, install this module with:

pip install path/to/fosdem22-demo-module

(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: fosdem22_demo.FosdemDemo
    config:
      # TODO: Complete this section with an example for your module

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

trial tests

To run the linters and mypy type checker, use ./scripts-dev/lint.sh.

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 the version 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/fosdem22_demo-$version*
```

Recommend Projects