diff --git a/README.md b/README.md index 0325e703e042814a1c58f012f1dc03c5a55efd2e..db6b6463399a2423bda90b83f90094b35c181e33 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,23 @@ 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. +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 diff --git a/pretix_matrix_inviter/__init__.py b/pretix_matrix_inviter/__init__.py index da97b4614cf09a442bc02f46f94ca16ea32f1383..44c0e7dbce7eea0504c62ccefe6433d066143de2 100644 --- a/pretix_matrix_inviter/__init__.py +++ b/pretix_matrix_inviter/__init__.py @@ -16,7 +16,7 @@ class PluginApp(PluginConfig): name = gettext_lazy("Matrix inviter") author = "Felix Schäfer" description = gettext_lazy( - "Ask participants for their Matrix ID and invite them to a Matrix Room or Space." + "Invite Pretix participants to a Matrix Room or Space." ) visible = True version = __version__ diff --git a/pretix_matrix_inviter/locale/de/LC_MESSAGES/django.po b/pretix_matrix_inviter/locale/de/LC_MESSAGES/django.po index b8dbeafb0f43569b94b657bfb4cad1ada8df3e8f..6da29fbe41e8f39e89cf539e1f79c07200d513ee 100644 --- a/pretix_matrix_inviter/locale/de/LC_MESSAGES/django.po +++ b/pretix_matrix_inviter/locale/de/LC_MESSAGES/django.po @@ -2,7 +2,7 @@ msgid "" msgstr "" "Project-Id-Version: \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-02-10 22:58+0100\n" +"POT-Creation-Date: 2022-02-11 12:44+0100\n" "PO-Revision-Date: \n" "Last-Translator: Felix Schäfer\n" "Language-Team: \n" @@ -15,15 +15,11 @@ msgstr "" #: pretix_matrix_inviter/__init__.py:16 pretix_matrix_inviter/signals.py:94 #: pretix_matrix_inviter/templates/pretix_matrix_inviter/settings.html:6 msgid "Matrix inviter" -msgstr "" +msgstr "Matrix-Inviter" #: pretix_matrix_inviter/__init__.py:19 -msgid "" -"Ask participants for their Matrix ID and invite them to a Matrix Room or " -"Space." -msgstr "" -"Matrix-ID abfragen und Teilnehmende zu einem Matrix-Raum oder -Space " -"einladen." +msgid "Invite Pretix participants to a Matrix Room or Space." +msgstr "Teilnehmende zu einem Matrix-Raum oder -Space einladen." #: pretix_matrix_inviter/forms.py:17 msgid "Ask Matrix ID for" @@ -85,17 +81,17 @@ msgstr "Dieser Text wird der Einladung zum Matrix-Raum zugefügt." msgid "Matrix room" msgstr "Matrix-Raum" -#: pretix_matrix_inviter/forms.py:67 +#: pretix_matrix_inviter/forms.py:69 #, python-brace-format msgid "\"{name}\" (main address: <code>{canonical_alias}</code>)" msgstr "„{name}“ (primäre Adresse: <code>{canonical_alias}</code>)" -#: pretix_matrix_inviter/forms.py:70 +#: pretix_matrix_inviter/forms.py:72 #, python-brace-format msgid "\"{name}\"" msgstr "„{name}“" -#: pretix_matrix_inviter/forms.py:74 +#: pretix_matrix_inviter/forms.py:76 #, python-brace-format msgid "" "\"{name}\" (<code>{room_id}</code>, main address: <code>{canonical_alias}</" @@ -104,7 +100,7 @@ msgstr "" "„{name}“ (<code>{room_id}</code>, primäre Adresse: <code>{canonical_alias}</" "code>)" -#: pretix_matrix_inviter/forms.py:77 +#: pretix_matrix_inviter/forms.py:79 #, python-brace-format msgid "\"{name}\" (<code>{room_id}</code>)" msgstr "„{name}“ (<code>{room_id}</code>)" diff --git a/pretix_matrix_inviter/locale/de_Informal/LC_MESSAGES/django.po b/pretix_matrix_inviter/locale/de_Informal/LC_MESSAGES/django.po index 795f7160a83dba3dce98a6e6cc00793ec6c63060..1e30fb68755fe72ddc1822d4a5a37adc067964d7 100644 --- a/pretix_matrix_inviter/locale/de_Informal/LC_MESSAGES/django.po +++ b/pretix_matrix_inviter/locale/de_Informal/LC_MESSAGES/django.po @@ -2,7 +2,7 @@ msgid "" msgstr "" "Project-Id-Version: \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-02-10 22:58+0100\n" +"POT-Creation-Date: 2022-02-11 12:44+0100\n" "PO-Revision-Date: \n" "Last-Translator: Felix Schäfer\n" "Language-Team: \n" @@ -18,9 +18,7 @@ msgid "Matrix inviter" msgstr "" #: pretix_matrix_inviter/__init__.py:19 -msgid "" -"Ask participants for their Matrix ID and invite them to a Matrix Room or " -"Space." +msgid "Invite Pretix participants to a Matrix Room or Space." msgstr "" #: pretix_matrix_inviter/forms.py:17 @@ -74,24 +72,24 @@ msgstr "" msgid "Matrix room" msgstr "" -#: pretix_matrix_inviter/forms.py:67 +#: pretix_matrix_inviter/forms.py:69 #, python-brace-format msgid "\"{name}\" (main address: <code>{canonical_alias}</code>)" msgstr "" -#: pretix_matrix_inviter/forms.py:70 +#: pretix_matrix_inviter/forms.py:72 #, python-brace-format msgid "\"{name}\"" msgstr "" -#: pretix_matrix_inviter/forms.py:74 +#: pretix_matrix_inviter/forms.py:76 #, python-brace-format msgid "" "\"{name}\" (<code>{room_id}</code>, main address: <code>{canonical_alias}</" "code>)" msgstr "" -#: pretix_matrix_inviter/forms.py:77 +#: pretix_matrix_inviter/forms.py:79 #, python-brace-format msgid "\"{name}\" (<code>{room_id}</code>)" msgstr "" diff --git a/pretix_matrix_inviter/locale/django.pot b/pretix_matrix_inviter/locale/django.pot index 4541574636c522a6947ad83b5b88e54f3c4825ef..9240ba89036306dd084441db7f3b9781f0696145 100644 --- a/pretix_matrix_inviter/locale/django.pot +++ b/pretix_matrix_inviter/locale/django.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-02-10 22:58+0100\n" +"POT-Creation-Date: 2022-02-11 12:44+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -23,9 +23,7 @@ msgid "Matrix inviter" msgstr "" #: pretix_matrix_inviter/__init__.py:19 -msgid "" -"Ask participants for their Matrix ID and invite them to a Matrix Room or " -"Space." +msgid "Invite Pretix participants to a Matrix Room or Space." msgstr "" #: pretix_matrix_inviter/forms.py:17 @@ -79,24 +77,24 @@ msgstr "" msgid "Matrix room" msgstr "" -#: pretix_matrix_inviter/forms.py:67 +#: pretix_matrix_inviter/forms.py:69 #, python-brace-format msgid "\"{name}\" (main address: <code>{canonical_alias}</code>)" msgstr "" -#: pretix_matrix_inviter/forms.py:70 +#: pretix_matrix_inviter/forms.py:72 #, python-brace-format msgid "\"{name}\"" msgstr "" -#: pretix_matrix_inviter/forms.py:74 +#: pretix_matrix_inviter/forms.py:76 #, python-brace-format msgid "" "\"{name}\" (<code>{room_id}</code>, main address: <code>{canonical_alias}</" "code>)" msgstr "" -#: pretix_matrix_inviter/forms.py:77 +#: pretix_matrix_inviter/forms.py:79 #, python-brace-format msgid "\"{name}\" (<code>{room_id}</code>)" msgstr "" diff --git a/pretix_matrix_inviter/locale/fr/LC_MESSAGES/django.po b/pretix_matrix_inviter/locale/fr/LC_MESSAGES/django.po index 8f79a9d75f8cc3ffd32233478bad16dddeac3ded..786b4715c80bcef6743765a9ac20725e5054a6c5 100644 --- a/pretix_matrix_inviter/locale/fr/LC_MESSAGES/django.po +++ b/pretix_matrix_inviter/locale/fr/LC_MESSAGES/django.po @@ -7,8 +7,8 @@ msgid "" msgstr "" "Project-Id-Version: \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-02-10 22:58+0100\n" -"PO-Revision-Date: 2022-02-11 01:07+0100\n" +"POT-Creation-Date: 2022-02-11 12:44+0100\n" +"PO-Revision-Date: 2022-02-11 12:44+0100\n" "Last-Translator: \n" "Language-Team: \n" "Language: fr\n" @@ -24,9 +24,7 @@ msgid "Matrix inviter" msgstr "Inviteur Matrix" #: pretix_matrix_inviter/__init__.py:19 -msgid "" -"Ask participants for their Matrix ID and invite them to a Matrix Room or " -"Space." +msgid "Invite Pretix participants to a Matrix Room or Space." msgstr "Invitez vos participant·es à un salon ou espace Matrix." #: pretix_matrix_inviter/forms.py:17 @@ -88,17 +86,17 @@ msgstr "Ce message sera joint à l’invitation au salon Matrix." msgid "Matrix room" msgstr "Salon Matrix" -#: pretix_matrix_inviter/forms.py:67 +#: pretix_matrix_inviter/forms.py:69 #, python-brace-format msgid "\"{name}\" (main address: <code>{canonical_alias}</code>)" msgstr "« {name} » (adresse principale : <code>{canonical_alias}</code>)" -#: pretix_matrix_inviter/forms.py:70 +#: pretix_matrix_inviter/forms.py:72 #, python-brace-format msgid "\"{name}\"" msgstr "« {name} »" -#: pretix_matrix_inviter/forms.py:74 +#: pretix_matrix_inviter/forms.py:76 #, python-brace-format msgid "" "\"{name}\" (<code>{room_id}</code>, main address: <code>{canonical_alias}</" @@ -107,7 +105,7 @@ msgstr "" "« {name} » (<code>{room_id}</code>, adresse principale : " "<code>{canonical_alias}</code>)" -#: pretix_matrix_inviter/forms.py:77 +#: pretix_matrix_inviter/forms.py:79 #, python-brace-format msgid "\"{name}\" (<code>{room_id}</code>)" msgstr "« {name} » (<code>{room_id}</code>)" diff --git a/setup.py b/setup.py index 096886413464b1a11321fff6ea9932a65abeef68..31586a7f2cf145dc9d246de265379d59ad42d36d 100644 --- a/setup.py +++ b/setup.py @@ -28,13 +28,25 @@ cmdclass = {"build": CustomBuild} setup( name="pretix-matrix-inviter", version=__version__, - description="Ask participants for their Matrix ID and invite them to a Matrix Room or Space.", + description="Invite Pretix participants 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", + project_urls={ + "Changelog": "https://gitlab.fachschaften.org/kif/pretix-matrix-inviter/-/blob/main/CHANGELOG.md", + "Tracker": "https://gitlab.fachschaften.org/kif/pretix-matrix-inviter/-/issues", + "Pretix Marketplace": "https://marketplace.pretix.eu/products/pretix-matrix-inviter/", + }, author="Felix Schäfer", author_email="admin@kif.rocks", - license="MIT License", + license="MIT", + classifiers=[ + "Development Status :: 5 - Production/Stable", + "Environment :: Pretix", + "Framework :: Django", + "License :: OSI Approved :: MIT License", + "Topic :: Communications :: Chat", + ], install_requires=["requests"], packages=find_packages(exclude=["tests", "tests.*"]), include_package_data=True,