Django Debug Toolbar dev setup

.isort.cfg

@@ -2,6 +2,5 @@
 # config compatible with Black
 line_length = 88
 multi_line_output = 3
-default_section = "THIRDPARTY"
 include_trailing_comma = true
 known_third_party = PyPDF2,arrow,bleach,bs4,captcha,django,environ,faker,ics,markdown,modelcluster,pirates,pytest,pytz,requests,sentry_sdk,snapshottest,taggit,wagtail,wagtailmetadata,weasyprint,yaml

README.md

@@ -136,6 +136,7 @@ Různé:
 | `MAJAK_ENV` | prod | `prod`/`test`/`dev` prostředí kde Maják běží |
 | `SENTRY_DSN` | | pokud je zadáno, pády se reportují do Sentry |
 | `SEARCH_CONFIG` | english | nastavení jazyka fulltextového vyhledávání, viz níže |
+| `DEBUG_TOOLBAR` | False | zobrazit Django Debug Toolbar (pro vývoj) |
 
 Settings pro appky na weby:
 
@@ -283,6 +284,13 @@ Django development server na portu `8006` se spustí příkazem:
 
 Poté můžete otevřít web na adrese [http://localhost:8006](http://localhost:8006)
 
+##### Debug Toolbar
+
+Pro spuštění development serveru s Django Debug Toolbar nastavte environment
+proměnnou `DEBUG_TOOLBAR`. Např.:
+
+    $ DEBUG_TOOLBAR=1 make run
+
 #### Django shell
 
 Django shell používající `shell_plus` z Django extensions spustíte:

majak/settings/dev.py

@@ -8,3 +8,15 @@ SECRET_KEY = env("DJANGO_SECRET_KEY", default="58asda4d6nasd*jkj!dbska83asd54")
 ALLOWED_HOSTS = env.list("DJANGO_ALLOWED_HOSTS", default=["*"])
 INSTALLED_APPS += ["wagtail.contrib.styleguide"]
 MAJAK_ENV = env.str("MAJAK_ENV", default="dev")
+
+# django-debug-toolbar
+# ------------------------------------------------------------------------------
+if env.bool("DEBUG_TOOLBAR", default=False):
+    INSTALLED_APPS += ["debug_toolbar"]
+    MIDDLEWARE += ["debug_toolbar.middleware.DebugToolbarMiddleware"]
+    DEBUG_TOOLBAR_CONFIG = {
+        "DISABLE_PANELS": ["debug_toolbar.panels.redirects.RedirectsPanel"],
+        "SHOW_TEMPLATE_CONTEXT": True,
+    }
+    INTERNAL_IPS = ["127.0.0.1"]
+    SILENCED_SYSTEM_CHECKS = ["debug_toolbar.W006"]

majak/urls.py

@@ -34,6 +34,12 @@ if settings.DEBUG:
     urlpatterns += staticfiles_urlpatterns()
     urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 
+    if "debug_toolbar" in settings.INSTALLED_APPS:
+        import debug_toolbar
+
+        urlpatterns = [path("__debug__/", include(debug_toolbar.urls))] + urlpatterns
+
+
 urlpatterns = urlpatterns + [
     # For anything not caught by a more specific rule above, hand over to
     # Wagtail's page serving mechanism. This should be the last pattern in

requirements/dev.in

+django-debug-toolbar
 pytest
 pytest-sugar
 pytest-factoryboy

requirements/dev.txt

@@ -4,10 +4,16 @@
 #
 #    pip-compile dev.in
 #
+asgiref==3.5.0
+    # via django
 attrs==21.4.0
     # via pytest
 coverage[toml]==6.3.2
     # via pytest-cov
+django==4.0.3
+    # via django-debug-toolbar
+django-debug-toolbar==3.2.4
+    # via -r dev.in
 factory-boy==3.2.1
     # via pytest-factoryboy
 faker==13.3.1
@@ -61,6 +67,10 @@ six==1.16.0
     #   snapshottest
 snapshottest==0.6.0
     # via -r dev.in
+sqlparse==0.4.2
+    # via
+    #   django
+    #   django-debug-toolbar
 termcolor==1.1.0
     # via
     #   pytest-sugar