Name | pretix-matrix-inviter JSON |
Version |
1.7.2
JSON |
| download |
home_page | |
Summary | Invite pretix participants to a Matrix Room or Space. |
upload_time | 2023-10-04 09:44:05 |
maintainer | |
docs_url | None |
author | |
requires_python | |
license | MIT License |
keywords |
pretix
matrix
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# pretix Matrix inviter
This is a plugin for [pretix](https://github.com/pretix/pretix).
Invite pretix participants to a Matrix Room or Space.
## Installation
Activate the virtual environment for your pretix installation and run
pip install pretix-matrix-inviter
## Configuration
Each event can enable this plugin in Settings > Plugins > Features.
Once the plugin is enabled you can configure it in Settings > Matrix inviter.
You will need an access token of a user that can invite new users to your
Matrix room or space, the address of the server said inviting user is on, and
the ID or an alias of the Matrix room or space your participants should be
invited to.
## 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.
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
To check your plugin for rule violations, run:
black --check .
isort -c .
flake8 .
You can auto-fix some of these issues by running:
isort .
black .
To automatically check for these issues before you commit, you can run
`.install-hooks`.
## License
Copyright 2022-2023 Felix Schäfer
Released under the terms of the MIT License
Raw data
{
"_id": null,
"home_page": "",
"name": "pretix-matrix-inviter",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "Felix Sch\u00e4fer <admin@kif.rocks>",
"keywords": "pretix,matrix",
"author": "",
"author_email": "Felix Sch\u00e4fer <admin@kif.rocks>",
"download_url": "https://files.pythonhosted.org/packages/fb/8f/3bd9a37f260e48063636b83a7898f764e34449b7a18376470bc3b1d75355/pretix-matrix-inviter-1.7.2.tar.gz",
"platform": null,
"description": "# pretix Matrix inviter\n\nThis is a plugin for [pretix](https://github.com/pretix/pretix).\n\nInvite pretix participants to a Matrix Room or Space.\n\n## Installation\n\nActivate the virtual environment for your pretix installation and run\n\n pip install pretix-matrix-inviter\n\n## Configuration\n\nEach event can enable this plugin in Settings > Plugins > Features.\n\nOnce the plugin is enabled you can configure it in Settings > Matrix inviter.\nYou will need an access token of a user that can invite new users to your\nMatrix room or space, the address of the server said inviting user is on, and\nthe ID or an alias of the Matrix room or space your participants should be\ninvited to.\n\n## Development setup\n\n1. Make sure that you have a working [pretix development\n setup](https://docs.pretix.eu/en/latest/development/setup.html).\n2. Clone this repository.\n3. Activate the virtual environment you use for pretix development.\n4. Execute `python setup.py develop` within this directory to register\n this application with pretix's plugin registry.\n5. Execute `make` within this directory to compile translations.\n6. Restart your local pretix server. You can now use the plugin from\n this repository for your events by enabling it in the 'plugins' tab\n in the settings.\n\nThis plugin has CI set up to enforce a few code style rules. To check\nlocally, you need these packages installed:\n\n pip install flake8 isort black\n\nTo check your plugin for rule violations, run:\n\n black --check .\n isort -c .\n flake8 .\n\nYou can auto-fix some of these issues by running:\n\n isort .\n black .\n\nTo automatically check for these issues before you commit, you can run\n`.install-hooks`.\n\n## License\n\nCopyright 2022-2023 Felix Sch\u00e4fer\n\nReleased under the terms of the MIT License\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Invite pretix participants to a Matrix Room or Space.",
"version": "1.7.2",
"project_urls": {
"Changelog": "https://gitlab.fachschaften.org/kif/pretix-matrix-inviter/-/blob/main/CHANGELOG.md",
"Homepage": "https://gitlab.fachschaften.org/kif/pretix-matrix-inviter",
"Repository": "https://gitlab.fachschaften.org/kif/pretix-matrix-inviter",
"Tracker": "https://gitlab.fachschaften.org/kif/pretix-matrix-inviter/-/issues",
"pretix Marketplace": "https://marketplace.pretix.eu/products/pretix-matrix-inviter/"
},
"split_keywords": [
"pretix",
"matrix"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4582eccf186d2f958be3090ed13d5887720a03328130b46ff74b23a379f96fc7",
"md5": "93945da305b78a8410984a6563b7d34a",
"sha256": "8c4e8fcae4e849907d04edd923446e63b8b7c9030fe8d9865a8b22978e0ff317"
},
"downloads": -1,
"filename": "pretix_matrix_inviter-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93945da305b78a8410984a6563b7d34a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22638,
"upload_time": "2023-10-04T09:44:04",
"upload_time_iso_8601": "2023-10-04T09:44:04.143529Z",
"url": "https://files.pythonhosted.org/packages/45/82/eccf186d2f958be3090ed13d5887720a03328130b46ff74b23a379f96fc7/pretix_matrix_inviter-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb8f3bd9a37f260e48063636b83a7898f764e34449b7a18376470bc3b1d75355",
"md5": "ff74dcc7f2545e09661b05da9b7af9a4",
"sha256": "cbfd4928eb335ba50f71786d6626415e3cb1d99f81dce7a6e9a6cac5ca3e073a"
},
"downloads": -1,
"filename": "pretix-matrix-inviter-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "ff74dcc7f2545e09661b05da9b7af9a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16058,
"upload_time": "2023-10-04T09:44:05",
"upload_time_iso_8601": "2023-10-04T09:44:05.765583Z",
"url": "https://files.pythonhosted.org/packages/fb/8f/3bd9a37f260e48063636b83a7898f764e34449b7a18376470bc3b1d75355/pretix-matrix-inviter-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-04 09:44:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pretix-matrix-inviter"
}