Skip to content

README.rst

Latest commit

 

History

History
85 lines (56 loc) · 2.85 KB

README.rst

File metadata and controls

85 lines (56 loc) · 2.85 KB
Raw

pretalx as a downstream service

PyPI version

This is a plugin for pretalx, allowing you to import external events that provide their schedule in the frab XML format.

It comes with several settings regulating pull interval and policies, as well as a manage command at downstream_pull --event my_event [--sync].

Installation

Install the plugin with pip, in the same environment as your pretalx installation:

(env)$ python -m pip install pretalx-downstream

Afterwards, run migrate and rebuild and restart your pretalx services, just like after any pretalx update (see performing updates in the administrator documentation).

You can then enable the plugin under "Settings → Plugins" in your event settings.

Development setup

  1. Make sure that you have a working pretalx development setup.
  2. Clone this repository, eg to local/pretalx-downstream.
  3. Activate the virtual environment you use for pretalx development.
  4. Run pip install -e . within this directory to register this application with pretalx's plugin registry.
  5. Restart your local pretalx server. This plugin should show up in the plugin list shown on startup in the console. You can now use the plugin from this repository for your events by enabling it in the 'plugins' tab in the settings.

Development commands

This plugin uses just as a task runner and uv for dependency management. Run just with no arguments to list every available command. The most useful ones are:

just fmt
Auto-format and lint the code.
just test
Run the full test suite with pytest.

Installing pretalx

The tests need pretalx installed in the environment. just test handles this for you: if pretalx cannot be imported, it installs the latest version from git before running the test suite.

If you already have a development version of pretalx around (for example if you want to test your changes against a specific commit or branch of pretalx), you can also install pretalx up front yourself:

just install-pretalx-local /path/to/pretalx
Install pretalx from a local checkout as an editable install.
just install-pretalx
Install the latest pretalx from git (runs before tests if no pretalx is installed).

License

Copyright 2018 Tobias Kunze

Released under the terms of the Apache License 2.0