Skip to content

Installation

Requirements

  • Python >= 3.12
  • Django >= 6.1

Installing the package

pip install django-workflow-kit

Optional extras

Optional integrations are installed as separate extras:

pip install django-workflow-kit[drf]  # Django REST Framework support
pip install django-workflow-kit[docs] # MkDocs documentation tooling

Celery and Redis integrations are not shipped in the core package. Future integrations should be installed from their own packages when they exist.

Configuring a Django project

  1. Add workflow_kit to your INSTALLED_APPS:

python INSTALLED_APPS = [ ... "workflow_kit", ]

  1. Run migrations:

bash python manage.py migrate

  1. (Optional) Configure the WORKFLOW_KIT settings dict. See Configuration.

Basic usage requires no configuration at all.

Development installation

git clone https://github.com/I-ruwaid-I/django-workflow-kit.git
cd django-workflow-kit
python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e ".[dev]"