Skip to content

Installation

Getting Django Cheroot running takes two steps: install the package, then register the app.

Terminal window
pip install django-cheroot

This pulls in Cheroot automatically. If you use a requirements.txt, add:

django-cheroot

Add django_cheroot to INSTALLED_APPS in your project’s settings.py:

INSTALLED_APPS = [
# ... your other apps
"django_cheroot",
]

Registering the app is what makes the cheroot management command discoverable. With it in place, the command shows up alongside Django’s built-in commands:

Terminal window
python manage.py cheroot --help
Supported
Python3.8 or newer
Django4.2, 5.x, or 6.0
Cheroot10 or newer (installed automatically)
  • Usage — start the server and pass arguments.
  • Configuration — the full option reference.