pretalx comes with commands that you can execute from the command line. Run them in the same environment you installed pretalx in. If you followed the installation guide, you can run the following as your pretalx user:
python -m pretalx <command> [<flags>] [<options>]
python -m pretalx migrate¶
migrate command updates the database tables to conform to what pretalx
expects. Please execute it once upon installation and then on every update. As
migrate touches the database, you should have a backup of the state before
the command run.
migrate if pretalx has no pending database changes is harmless. It
will result in no changes to the database.
If migrations touch upon large populated tables, they may run for some time. The release notes will include a warning if an upgrade can trigger this behaviour.
python -m pretalx showmigrations¶
If you ran into trouble during
showmigrations. It will
show you the current state of all pretalx migrations. It may be useful debug
output to include in bug reports about database problems.
python -m pretalx clearsessions¶
This command will remove old and unusable sessions from the database. We recommend that you run it about once a month to keep your database at a reasonable size.
python -m pretalx shell_scoped¶
shell_scoped command opens a Python shell with the pretalx
configuration and environment. You can use it to import pretalx modules and
execute methods. For a better environment, install
ipython, and execute
shell_plus instead. This shell gives you tab
completion, and a range of useful initial imports.
You’ll have to provide the event you want to interact with to provide proper database isolation:
python -m pretalx shell_scoped --event__slug=myevent
Alternatively, you can specify that you want to be able to access all events:
python -m pretalx shell_scoped --override
python -m pretalx print_settings¶
If other debugging fails, install the
django_extensions package. Run
print_settings to receive full settings output. The output will contain
passwords, so sanitise it before pasting it anywhere.
If you don’t want to install a library for debugging, you can run these commands instead:
python -m pretalx shell >>> from django.conf import settings >>> from pprint import pprint >>> pprint(settings.__dict__)
The warning about included passwords and secrets in the output goes for this version as well.
Core pretalx commands¶
python -m pretalx rebuild¶
rebuild command regenerates all static files. With the
flag, it replaces all static files with ones compiled from scratch. Run this
command after every upgrade.
python -m pretalx regenerate_css¶
regenerate_css command regenerates only the custom CSS for events. It
only runs for events with a specified custom color, or custom uploaded styles.
You can specify an event slug with
--event. If no event is specified, the
files for all relevant events will be rebuilt.
python -m pretalx init¶
init command allows you to create a superuser and an organiser. It is
useful to give you all the tools to start configuring pretalx in the web
interface. Please run this command once in the beginning. You can abort the
command at any time, and it will not write anything to the database.
python -m pretalx createsuperuser¶
If you need more users after generating your initial administration user,
createsuperuser. Please note that superusers have access to all areas
of all events.
python -m pretalx runperiodic¶
Please run the
runperiodic command via a cronjob in regular intervals. You
can also trigger it if you think that something went wrong with the regular
python -m pretalx export_schedule_html¶
This command requires an event slug as an argument. You can provide the
--zip flag to produce a zip archive instead of a directory structure. The
command will print the location of the HTML export upon successful exit.
python -m pretalx import_schedule¶
import_schedule allows you to import a conference schedule xml file.
It takes the path to the xml file as its argument. If pretalx can find no event
with the specified slug in the database, it will create a new event and a new
For existing events, pretalx will release a new schedule version instead.
python -m pretalx create_test_event¶
This command will create a test event for you, with a set of test submissions,
and speakers, and the like. You will need to install the
--stage flag, you can determine which stage the event in question
should be in. The available choices are
cfp (CfP still open, plenty of
submissions, but no reviews),
review (submissions have been reviewed and
schedule (there is a schedule and the event is
currently running), and
schedule is the default value.
--slug flag allows you to specify the slug of the event to be created.
It defaults to
democon. Please only use alphanumerical characters and
in the slug, otherwise you won’t be able to see the event in the web interface.