Django integration

While we tries our best for Procrastinate to be easily integrated into diverse kinds of applications, Django is special enough and widely used enough to have a special integration.

Within Django, Procrastrinate will configure its app for you, using Django’s Database settings, and load tasks automatically from your apps. It will also provide a few Django models & admin pages to look at the Procrastinate tables from within Django. Django migrations are also provided so that you don’t need to handle multiple migration systems.

The following pages will guide you through the specifics of using Procrastinate within a Django app.

• Configure Django & Procrastinate to work together
  • Configuration
  • Configuring the app
• Use Procrastinate in a Django application
  • Defining tasks
  • Running the worker & other CLI commands
  • Deferring jobs
  • Checking proper configuration
• Use Procrastinate migrations with Django
• Interact with Procrastinate tables as Django models
  • Reference documentation
    • ProcrastinateEvent
      • ProcrastinateEvent.DoesNotExist
      • ProcrastinateEvent.MultipleObjectsReturned
    • ProcrastinateJob
      • ProcrastinateJob.DoesNotExist
      • ProcrastinateJob.MultipleObjectsReturned
    • ProcrastinatePeriodicDefer
      • ProcrastinatePeriodicDefer.DoesNotExist
      • ProcrastinatePeriodicDefer.MultipleObjectsReturned
  • Making the models writable in tests
• Customize the app integration through settings
  • PROCRASTINATE_ON_APP_READY
• Get Procrastinate logs
• Test Procrastinate interactions in a Django project
  • Unit tests
  • Integration tests
  • Making the models writable in tests
• Run Procrastinate code at Django startup
• Running custom Django scripts