Work

Author: jarofgreen

.devcontainer.json

@@ -3,6 +3,7 @@
 	"dockerComposeFile": "docker-compose.dev.yml",
 	"service": "app",
 	"workspaceFolder": "/oc4ids_datastore_pipeline",
+	"forwardPorts": [5432],
 	"customizations": {
 		"vscode": {
 			"extensions":["ms-python.python"]

Dockerfile

@@ -11,6 +11,6 @@ RUN pip install -r requirements.txt
 
 COPY . .
 
-RUN pip install .
+RUN pip install -e .
 
 ENTRYPOINT ["sh", "-c", "alembic upgrade head && oc4ids-datastore-pipeline"]

Dockerfile.dev

@@ -13,4 +13,4 @@ COPY . .
 
 RUN pip install .
 
-ENTRYPOINT ["sleep", "infinity"]
+CMD ["sleep", "infinity"]

README.md

@@ -2,25 +2,16 @@
 
 A Python application to validate and store published OC4IDS datasets.
 
-## Local Development
+## Local Development via Dev Containers or Docker Compose
 
-### Prerequisites
+You can open this repository in a dev container to get an environment complete with Postgres database.
 
-- Python 3.12
-- Postgres
-
-### Install Python requirements
-
-```
-python -m venv .venv
-source .venv/bin/activate
-pip install -r requirements_dev.txt
-```
-
-### Set database enrivonment variable
+If you prefer to use Docker Compose, you can instead run:
 
 ```
-export DATABASE_URL="postgresql://oc4ids_datastore@localhost/oc4ids_datastore"
+docker compose -f docker-compose.dev.yml up -d
+docker compose -f docker-compose.dev.yml exec app bash
+docker compose -f docker-compose.dev.yml stop
 ```
 
 ### Run database migrations
@@ -92,6 +83,17 @@ To send failure notifications by email, the following environment variables must
 pip install -e .
 oc4ids-datastore-pipeline
 ```
+### Access Database
+
+From inside the dev container or Docker container:
+
+```
+psql postgresql://postgres:postgres@localhost:5432/postgres
+```
+
+Connecting from outside:
+* If using a dev container or Docker Compose locally the same command should work
+* In GitHub Codespaces, we're not sure how to access the port
 
 ### Run linting and type checking
 

docker-compose.dev.yml

@@ -3,23 +3,13 @@ services:
     build:
       context: .
       dockerfile: Dockerfile.dev
-
     volumes:
       - .:/oc4ids_datastore_pipeline:cached
-
-    # Overrides default command so things don't shut down after the process ends.
-    #command: sleep infinity
-
     # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
     network_mode: service:db
-
-    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
-    # (Adding the "ports" property to this file will not forward from a Codespace.)
     environment:
       - DATABASE_URL=postgresql://postgres:postgres@localhost/postgres
 
-    entrypoint: sleep infinity
-
   db:
     image: postgres:latest
     restart: unless-stopped
@@ -29,11 +19,9 @@ services:
       POSTGRES_USER: postgres
       POSTGRES_DB: postgres
       POSTGRES_PASSWORD: postgres
+    # Forwarding this port so people can access the DB when run via Docker Compose.
     ports: 
-      - 54321:5432
-
-    # Add "forwardPorts": ["5432"] to **devcontainer.json** to forward PostgreSQL locally.
-    # (Adding the "ports" property to this file will not forward from a Codespace.)
+      - 5432:5432
 
 volumes:
   postgres-data: