Merge pull request #64 from SADiLaR/feature/debug-tool

added debug tool

Author: daniel-gray-tangent

app/app/settings.py

@@ -48,9 +48,12 @@
     "general",
     "simple_history",
 ]
+
+# Add django-extensions to the installed apps if DEBUG is True
 if DEBUG:
     INSTALLED_APPS += [
         "django_extensions",
+        "debug_toolbar",
     ]
 
 AUTH_USER_MODEL = "users.CustomUser"
@@ -68,6 +71,10 @@
     "django.middleware.locale.LocaleMiddleware",
 ]
 
+# Add debug toolbar middleware
+if DEBUG:
+    MIDDLEWARE.insert(0, "debug_toolbar.middleware.DebugToolbarMiddleware")
+
 ROOT_URLCONF = "app.urls"
 
 TEMPLATES = [
@@ -104,6 +111,18 @@
     }
 }
 
+# toolbar settings
+if DEBUG:
+    DEBUG_TOOLBAR_CONFIG = {
+        "IS_RUNNING_TESTS": False,
+        "SHOW_TOOLBAR_CALLBACK": lambda request: DEBUG,
+    }
+
+    INTERNAL_IPS = [
+        "host.docker.internal",
+    ]
+
+# Check if the application is under testing
 if "test" in sys.argv or "test_coverage" in sys.argv:  # Covers regular testing and django-coverage
     DATABASES["default"]["ENGINE"] = "django.db.backends.sqlite3"
 
@@ -144,13 +163,12 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/5.0/howto/static-files/
 
-
+# Static files (CSS, JavaScript, Images)
 if DEBUG:
     _STATICFILES_BACKEND = "django.contrib.staticfiles.storage.StaticFilesStorage"
 else:
     _STATICFILES_BACKEND = "whitenoise.storage.CompressedManifestStaticFilesStorage"
 
-
 STATIC_URL = "/static/"
 STATICFILES_DIRS = [
     BASE_DIR / "static",
@@ -192,6 +210,7 @@
 if "test" in sys.argv:
     DEBUG = False
 
+# Logging configuration
 if DEBUG:
     LOGGING = {
         "version": 1,

app/app/urls.py

@@ -37,3 +37,4 @@
 
 if settings.DEBUG:
     urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
+    urlpatterns.append(path("__debug__/", include("debug_toolbar.urls")))

docker-compose.yml

@@ -29,6 +29,8 @@ services:
       - "8000:8000"
     depends_on:
       - db
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
     environment:
       # TODO: dollar signs in the KEY are interpolated, therefore escaped here
       # with double "$$". Maybe move to .env file to simplify?

requirements-dev.txt

@@ -1,4 +1,5 @@
 -r requirements.txt
+django-debug-toolbar
 django-extensions
 pygraphviz
 ruff

requirements-test.txt

@@ -1,4 +1,5 @@
 -r requirements.txt
+django-debug-toolbar
 django-extensions
 ruff
 faker