Setup

This guide describes the setup of the openaleph-procrastinate app and mainly the Django integration that can be used to explore job statistics.

Installation

Install openaleph-procrastinate with its Django requirements:

pip:

pip install openaleph-procrastinate

poetry:

poetry add openaleph-procrastinate

This will include all the required dependencies.

Info

For local development or testing, set the environment variable DEBUG=1 to use an in-memory task backend instead of postgresql.

The OpenAleph settings are configured via environment vars via pydantic-settings.

For a full list of openaleph-procrastinate settings, refer to the settings reference.

Set up the environment variable PROCRASTINATE_DB_URI which falls back to OPENALEPH_DB_URI (default: postgresql:///openaleph).

opal-procrastinate init-db

Django can be installed as an optional dependency to use the Django admin for better task status visibility.

pip:

pip install openaleph-procrastinate[django]

poetry:

poetry add openaleph-procrastinate[django]

This will include all the required Django dependencies.

Instead, as procrastinate is already configured in the Django app, use the Django database migrations:

./manage.py migrate

This will create the Django database tables as well as the procrastinate tables.

Create an admin user to visit the dashboard:

./manage.py createsuperuser

Run the development server:

./manage.py runserver

Visit the admin dashboard at http://localhost:8000/admin/