pretix-esncard 1.1.3.post1

A plugin for pretix allowing automated validation of ESNcard numbers

ESNcard Validity Checker

A plugin for Pretix allowing automated validation of ESNcard numbers.

Installation

Make sure to run from Pretix's virtual environment:

sudo -u pretix -s
source /var/pretix/venv/bin/activate

Install the package and update the database:

pip3 install pretix-esncard
python -m pretix migrate
python -m pretix rebuild

Restart Pretix:

sudo systemctl restart pretix-web pretix-worker

For more information about plugin installation, see the Pretix documentation.

Usage

Setup

Activate the plugin from the organizer or event settings.

Go to Products > Questions and select "Create a new question"

• Question: "ESNcard number"
• Type: Text (one line)
• Products: Select all product which have an ESNcard discount
• Check "required question"

Go to the Advanced tab

Optionally write a help text such as the following:

If you have issues proceeding due to your ESNcard, please make sure it is registered on ESNcard.org and that you type it correctly (do not include any spaces etc).

If you just registered your card, it may take up to 4 hours until it shows up in our system!

Internal identifier: esncard

[!NOTE] You must write exactly this identifier for the plugin to work.

Validation

The ESNcard number is validated against the ESNcard API during checkout and the customer is notified of any errors.

Development

1. Make sure that you have a working pretix development setup

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. 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 2023 ESN Sea Battle OC

Released under the terms of the Apache License 2.0