initial setup

.env.example

@@ -2,6 +2,7 @@ DJANGO_SETTINGS_MODULE=config.settings.local
 SECRET_KEY=super-secret-key
 ALLOWED_HOSTS="*"
 DEBUG=True
+ENABLE_DEBUGPY=false
 DISABLE_COLLECTSTATIC="0"
 DATABASE_URL=psql://postgres:postgres@db:5432/fido
 CACHE_ENDPOINT=redis://redis:6379

README.md

@@ -140,3 +140,31 @@ The names of the management commands denote their function.
 - Amend the custom_usermodel table to be the same as the new User app one
 - Add the user app initial migration to the list of django migrations that have been run
 - Deploy new codebase
+
+# Setup DebugPy
+
+Add environment variable in your .env file
+
+    ENABLE_DEBUGPY=True
+
+Create launch.json file inside .vscode directory
+
+    {
+        "version": "0.2.0",
+        "configurations": [
+            {
+                "name": "Python: Remote Attach (DebugPy)",
+                "type": "python",
+                "request": "attach",
+                "port": 5678,
+                "host": "localhost",
+                "pathMappings": [
+                    {
+                        "localRoot": "${workspaceFolder}",
+                        "remoteRoot": "/app/"
+                    }
+                ],
+                "justMyCode": true
+            },
+        ]
+    }

config/settings/base.py

@@ -33,6 +33,8 @@
 
 DEBUG = env.bool("DEBUG", default=False)
 
+ENABLE_DEBUGPY = env.bool("ENABLE_DEBUGPY", False)
+
 # SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = env("SECRET_KEY")
 

docker-compose.yml

@@ -12,7 +12,8 @@ services:
     command: python manage.py runserver 0.0.0.0:8000
     # command: granian --interface wsgi config.wsgi:application --workers 2 --host 0.0.0.0 --port 8000
     ports:
-      - "0.0.0.0:8000:8000"
+      - "8000:8000"
+      - "5678:5678"
     volumes:
       - ./:/app/
     depends_on:

manage.py

@@ -2,8 +2,14 @@
 import os
 import sys
 
+def initialize_debugpy():
+    import debugpy
 
-if __name__ == "__main__":
+    if not os.getenv("RUN_MAIN"):
+        debugpy.listen(("0.0.0.0", 5678))
+        sys.stdout.write("debugpy listening on port 5678...\n")
+
+def main():
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.prod")
     try:
         from django.core.management import execute_from_command_line
@@ -13,11 +19,19 @@
         # exceptions on Python 2.
         try:
             import django
-        except ImportError:
+        except ImportError as exc:
             raise ImportError(
                 "Couldn't import Django. Are you sure it's installed and "
                 "available on your PYTHONPATH environment variable? Did you "
                 "forget to activate a virtual environment?"
-            )
+            ) from exc
         raise
     execute_from_command_line(sys.argv)
+
+if __name__ == "__main__":
+    ENABLE_DEBUGPY = os.getenv("ENABLE_DEBUGPY")
+    print("DEBUGPY: ", ENABLE_DEBUGPY)
+    if ENABLE_DEBUGPY and ENABLE_DEBUGPY.lower() == "true":
+        initialize_debugpy()
+    main()
+

pyproject.toml

@@ -50,6 +50,7 @@ django-log-formatter-asim = "^0.0.6"
 optional = true
 
 [tool.poetry.group.dev.dependencies]
+debugpy = "^1.8.9"
 selenium = "^4.18.1"
 beautifulsoup4 = "^4.9.1"
 soupsieve = "^2.5"