Skip to content
Snippets Groups Projects
Commit e50d2b6c authored by Felix Schäfer's avatar Felix Schäfer :construction_worker:
Browse files

Convert README to markdown

parent 1fb8ce55
No related branches found
No related tags found
No related merge requests found
Pipeline #65036 passed
Matrix Inviter
==========================
# Matrix Inviter
This is a plugin for `pretix`_.
This is a plugin for [pretix](https://github.com/pretix/pretix).
Ask participants for their Matrix ID and invite them to a Matrix Room or Space.
Ask participants for their Matrix ID and invite them to a Matrix Room or
Space.
Development setup
-----------------
1. Make sure that you have a working `pretix development setup`_.
## Development setup
1. Make sure that you have a working [pretix development
setup](https://docs.pretix.eu/en/latest/development/setup.html).
2. Clone this repository.
3. Activate the virtual environment you use for pretix development.
4. Execute `python setup.py develop` within this directory to register
this application with pretix's plugin registry.
5. Execute `make` within this directory to compile translations.
6. Restart your local pretix server. You can now use the plugin from
this repository for your events by enabling it in the 'plugins' tab
in the settings.
4. Execute ``python setup.py develop`` within this directory to register this application with pretix's plugin registry.
5. Execute ``make`` within this directory to compile translations.
6. Restart your local pretix server. You can now use the plugin from this repository for your events by enabling it in
the 'plugins' tab in the settings.
This plugin has CI set up to enforce a few code style rules. To check locally, you need these packages installed::
This plugin has CI set up to enforce a few code style rules. To check
locally, you need these packages installed:
pip install flake8 isort black docformatter
To check your plugin for rule violations, run::
To check your plugin for rule violations, run:
docformatter --check -r .
black --check .
isort -c .
flake8 .
You can auto-fix some of these issues by running::
You can auto-fix some of these issues by running:
docformatter -r .
isort .
black .
To automatically check for these issues before you commit, you can run ``.install-hooks``.
License
-------
To automatically check for these issues before you commit, you can run
`.install-hooks`.
## License
Copyright 2022 Felix Schäfer
Released under the terms of the MIT License
.. _pretix: https://github.com/pretix/pretix
.. _pretix development setup: https://docs.pretix.eu/en/latest/development/setup.html
......@@ -9,7 +9,7 @@ from pretix_matrix_inviter import __version__
try:
with open(
os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf-8"
os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8"
) as f:
long_description = f.read()
except Exception:
......@@ -30,6 +30,7 @@ setup(
version=__version__,
description="Ask participants for their Matrix ID and invite them to a Matrix Room or Space.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://gitlab.fachschaften.org/kif/pretix-matrix-inviter",
author="Felix Schäfer",
author_email="admin@kif.rocks",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment