Creating a plugin¶

Plugin metadata¶

The plugin metadata lives inside a PretixPluginMeta class inside your app’s configuration class. The metadata class must define the following attributes:

A working example would be:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

try:
    from pretix.base.plugins import PluginConfig
except ImportError:
    raise RuntimeError("Please use pretix 2.7 or above to run this plugin!")
from django.utils.translation import gettext_lazy as _


class PaypalApp(PluginConfig):
    name = 'pretix_paypal'
    verbose_name = _("PayPal")

    class PretixPluginMeta:
        name = _("PayPal")
        author = _("the pretix team")
        version = '1.0.0'
        category = 'PAYMENT'
        picture = 'pretix_paypal/paypal_logo.svg'
        visible = True
        featured = False
        restricted = False
        description = _("This plugin allows you to receive payments via PayPal")
        compatibility = "pretix>=2.7.0"


default_app_config = 'pretix_paypal.PaypalApp'

The AppConfig class may implement a property compatibility_errors, that checks whether the pretix installation meets all requirements of the plugin. If so, it should contain None or an empty list, otherwise a list of strings containing human-readable error messages. We recommend using the django.utils.functional.cached_property decorator, as it might get called a lot. You can also implement compatibility_warnings, those will be displayed but not block the plugin execution.

The AppConfig class may implement a method is_available(event) that checks if a plugin is available for a specific event. If not, it will not be shown in the plugin list of that event. You should not define is_available and restricted on the same plugin.

Plugin registration¶

Somehow, pretix needs to know that your plugin exists at all. For this purpose, we make use of the entry point feature of setuptools. To register a plugin that lives in a separate python package, your setup.py should contain something like this:

1
2
3
4
5
6
7

setup(
    args...,
    entry_points="""
[pretix.plugin]
pretix_paypal=pretix_paypal:PretixPluginMeta
"""
)

This will automatically make pretix discover this plugin as soon as it is installed e.g. through pip. During development, you can just run python setup.py develop inside your plugin source directory to make it discoverable.

Signals¶

The various components of pretix define a number of signals which your plugin can listen for. We will go into the details of the different signals in the following pages. We suggest that you put your signal receivers into a signals submodule of your plugin. You should extend your AppConfig (see above) by the following method to make your receivers available:

1
2
3
4
5

class PaypalApp(AppConfig):
    …

    def ready(self):
        from . import signals  # NOQA

You can optionally specify code that is executed when your plugin is activated for an event in the installed method:

1
2
3
4
5

class PaypalApp(AppConfig):
    …

    def installed(self, event):
        pass  # Your code here

Note that installed will not be called if the plugin is indirectly activated for an event because the event is created with settings copied from another event.

Views¶

Your plugin may define custom views. If you put an urls submodule into your plugin module, pretix will automatically import it and include it into the root URL configuration with the namespace plugins:<label>:, where <label> is your Django app label.