🛠 Add VS Code debugging support (#61)

* 🛠  Add support for debugging the application

* Added basic debugging instructions to the README

* Fix formatting in main.py

* Remove comments from launch.json

* Update docs with README debugging info

Author: rkorsak

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Web API",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceRoot}/app/main.py",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceRoot}"
+            }
+        }
+    ]
+}

README.md

@@ -32,6 +32,12 @@ To start the api:
 make start
 ```
 
+## 🛠 Debugging
+
+For local debugging with Visual Studio Code, choose the `Web API` option from the dropdown in the Run menu.  Once the server is up, you can easily hit your breakpoints.
+
+If the code fails to run, [make sure your Python interpreter is set](https://code.visualstudio.com/docs/python/environments) to use your pipenv environment.
+
 ## 🐳 Docker
 A DockerFile is available to quickly create and run a docker container.
 

app/main.py

@@ -19,3 +19,14 @@
     )
 
 app.include_router(api_router, prefix=settings.API_V1_STR)
+
+if __name__ == "__main__":
+    # IMPORTANT: This should only be used to debug the application.
+    # For normal execution, run `make start`.
+    #
+    # To make this work, the PYTHONPATH must be set to the root directory, e.g.
+    # `PYTHONPATH=. pipenv run python ./app/main.py`
+    # See the VSCode launch configuration for detail.
+    import uvicorn
+
+    uvicorn.run(app, host="0.0.0.0", port=8000)

docs/index.md

@@ -32,6 +32,12 @@ To start the api:
 make start
 ```
 
+## 🛠 Debugging
+
+For local debugging with Visual Studio Code, choose the `Web API` option from the dropdown in the Run menu.  Once the server is up, you can easily hit your breakpoints.
+
+If the code fails to run, [make sure your Python interpreter is set](https://code.visualstudio.com/docs/python/environments) to use your pipenv environment.
+
 ## 🐳 Docker
 A DockerFile is available to quickly create and run a docker container.