generated from coop-cloud/example
49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
# pretix-selective-export (draft)
|
|
|
|
pretix exporter plugin that lets you pick exactly which fields to export.
|
|
It supports event-level exports as well as organizer-level exports that aggregate
|
|
all events into one file.
|
|
|
|
Notes:
|
|
- Activate the plugin at the organizer level to use multi-event exports.
|
|
- Activate it for an event to use event-level exports.
|
|
- Field selection includes model fields, related labels, invoice fields (when
|
|
invoice addresses exist), and question answers (when answers exist).
|
|
- Presets: save/load field selections directly on the export form without reloading.
|
|
Presets are stored in the browser (localStorage) per URL/event.
|
|
|
|
## Setup (pretix + plugin)
|
|
|
|
These steps assume a local pretix checkout and Python 3.10+.
|
|
|
|
1) Create and activate a virtualenv:
|
|
```
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
2) Install pretix (editable) and its dev requirements:
|
|
```
|
|
git clone https://github.com/pretix/pretix.git
|
|
cd pretix
|
|
pip install -U pip
|
|
pip install -e ".[dev]"
|
|
```
|
|
|
|
3) Install this plugin (editable):
|
|
```
|
|
pip install -e /path/to/selective_export_plugin
|
|
```
|
|
|
|
4) Enable the plugin in pretix:
|
|
- Add `pretix_selective_export` to the `PLUGINS` list in your pretix config.
|
|
|
|
5) Run pretix and use the exporter:
|
|
- Start pretix using the standard dev-server command for your checkout. Common options are:
|
|
```
|
|
python src/manage.py runserver
|
|
```
|
|
- If that doesn't work in your setup, follow the upstream pretix development setup instructions and use their start command.
|
|
- For event-level exports: enable the plugin on the event and go to the export page.
|
|
- For organizer-level exports: enable the plugin on the organizer and use the organizer export page (single aggregated file).
|