81
Django Debug Toolbar - How to configure
Hello Coders,
This article explains how to add the popular Debug Toolbar to a Django project. For newcomers, the Django Debug Toolbar is a configurable set of panels that bumps various information about the current request/response when clicked. To make this article more useful, an open-source sample already configured is provided on Github (MIT License).
Thanks for reading! - Content provided by App Generator.
Step #1 - Add django-debug-toolbar to project dependencies
# File: requirements.txt
...
django-debug-toolbar
...Or simply install via PIP
$ pip install django-debug-toolbarStep #2 - Update project routes
# File core/urls.py
import debug_toolbar # <-- NEW
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
...
path('__debug__/', include(debug_toolbar.urls)), # <-- NEW
...
]Step #3 - Update Settings
# File core/settings.py
...
from decouple import config
from unipath import Path
import dj_database_url
import mimetypes # <-- NEW
BASE_DIR = Path(__file__).parent
INSTALLED_APPS = [
...
'django.contrib.staticfiles',
'debug_toolbar', # <-- NEW
...
]
MIDDLEWARE = [
...
'django.middleware.clickjacking.XFrameOptionsMiddleware',
'debug_toolbar.middleware.DebugToolbarMiddleware', # <-- NEW
...
]
INTERNAL_IPS = [ # <-- NEW
'127.0.0.1', # <-- NEW
] # <-- NEW
def show_toolbar(request): # <-- NEW
return True # <-- NEW
DEBUG_TOOLBAR_CONFIG = { # <-- NEW
"SHOW_TOOLBAR_CALLBACK" : show_toolbar, # <-- NEW
} # <-- NEW
if DEBUG: # <-- NEW
import mimetypes # <-- NEW
mimetypes.add_type("application/javascript", ".js", True) # <-- NEWStep #4 - Execute the migration
$ python manage.py makemigrations
$ python manage.py migrateStep #5 - Start the Django Project
$ python manage.py runserverAt this point, the Debug Toolbar should be visible on the right side for all pages.
Thanks for reading! For more resources please access:
81