feat(debug): setup for vscode debugging

Author: Avantol13

.vscode/launch.json

@@ -0,0 +1,62 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "gen3_inference",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": [
+                "gen3_inference.main:app_instance",
+                "--reload",
+                "--reload-dir",
+                "./services/gen3_inference/src/gen3_inference",
+                "--port",
+                "4143",
+                "--env-file",
+                ".env",
+                "--app-dir",
+                "./services/gen3_inference/src/gen3_inference"
+            ],
+            "jinja": true
+        },
+        {
+            "name": "gen3_embeddings",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": [
+                "gen3_embeddings.main:app_instance",
+                "--reload",
+                "--reload-dir",
+                "./services/gen3_embeddings/src/gen3_embeddings",
+                "--port",
+                "4142",
+                "--env-file",
+                ".env",
+                "--app-dir",
+                "./services/gen3_embeddings/src/gen3_embeddings"
+            ],
+            "jinja": true
+        },
+        {
+            "name": "gen3_ai_model_repo",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": [
+                "gen3_ai_model_repo.main:app_instance",
+                "--reload",
+                "--reload-dir",
+                "./services/gen3_ai_model_repo/src/gen3_ai_model_repo",
+                "--port",
+                "4141",
+                "--env-file",
+                ".env",
+                "--app-dir",
+                "./services/gen3_ai_model_repo/src/gen3_ai_model_repo"
+            ],
+            "jinja": true
+        }
+    ]
+}

README.md

@@ -129,14 +129,20 @@ just lint services/gen3_inference -v
 * PostgreSQL for services that need a database
 * No ORM. `asyncpg` with shared code in `libraries/common`
 
-## Metrics
+## Development Details
+
+### Using VSCode?
+
+See [these docs](./docs/vscode.md) for more info on how to best set up for development of this repo.
+
+### Metrics
 
 By default, we support Prometheus metrics. They can be exposed at a `/metrics` endpoint compatible with Prometheus scraping and visualize in Prometheus or
 Graphana, etc.
 
 You can [run Prometheus locally](https://github.com/prometheus/prometheus) if you want to test or visualize these.
 
-### tl;dr
+#### Setup Locally
 
 Run the service locally using `just run {{service}}`.
 

docs/vscode.md

@@ -0,0 +1,24 @@
+# VSCode
+
+## Debugging
+
+This comes bundled with a `launch.json` which uses uvicorn to launch the apps.
+
+This allows you to easily debug in VSCode.
+
+Go to the "Run and Debug" pane and you should see each of the services available to run:
+
+- `gen3_inference`
+- `gen3_embeddings`
+- `gen3_ai_model_repo`
+
+## Importing Common Libraries
+
+You may need to add this to your .vscode/settings.json for intellisense to pick up the common libraries:
+
+```
+"python.analysis.extraPaths": [
+    "./libraries/common",
+    "./libraries/common/src"
+]
+```

libraries/common/pyproject.toml

@@ -36,6 +36,7 @@ dev = [
     "pytest-xdist",
     "pyright",
     "pylint>=4.0.5",
+    "dotenv>=0.9.9",
 ]
 
 [tool.uv]