Organize local artifacts into dir

.devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/vscode-remote/devcontainer.json
 {
     "name": "Benefits",
-    "dockerComposeFile": ["./docker-compose.yml"],
+    "dockerComposeFile": ["./localhost/docker-compose.yml"],
     "service": "dev",
     "runServices": ["dev", "docs", "server"],
     "workspaceFolder": "/home/calitp/app",

.dockerignore

@@ -1,8 +1,7 @@
 .git/
 .github/
 .vscode/
-keys/
-server/
+localhost/
 **/__pycache__/
 .devcontainer.json
 .flake8

.pyup.yml

@@ -5,5 +5,5 @@ branch: dev
 schedule: ""
 update: all
 requirements:
-  - server/requirements.txt:
+  - localhost/server/requirements.txt:
       update: False

.vscode/launch.json

@@ -24,7 +24,7 @@
             },
             "pathMappings": [
                 {
-                    "localRoot": "${workspaceFolder}/server",
+                    "localRoot": "${workspaceFolder}/localhost/server",
                     "remoteRoot": "/usr/src/server"
                 }
             ]

README.md

@@ -10,7 +10,7 @@ Clone the repository:
 
 ```console
 git clone https://github.com/cal-itp/benefits
-cd benefits
+cd benefits/localhost
 ```
 
 Create an environment file from the sample:
@@ -36,7 +36,8 @@ After initialization, the client is running at `http://localhost:${DJANGO_LOCAL_
 If `DJANGO_ADMIN=true`, the backend administrative interface can be accessed with the superuser you setup at
 <http://localhost:8000/admin>.
 
-By default, sample data from [`data/client.json`](./data/client.json) is used to initialize Django. Alternatively you may:
+By default, sample data from [`localhost/data/client.json`](./localhost/data/client.json) is used to initialize Django.
+Alternatively you may:
 
 * Modify the sample data file; or
 * Point `DJANGO_INIT_PATH` at a different data file; or
@@ -59,7 +60,7 @@ docker-compose up [-d] --build server
 
 The API endpoint is running at `http://localhost:5000/verify`.
 
-Sample users and eligibility can be found in [`data/server.json`](./data/server.json).
+Sample users and eligibility can be found in [`localhost/data/server.json`](./localhost/data/server.json).
 
 ## Development
 

.env.sample → localhost/.env.sample

@@ -1,3 +1,6 @@
+# Docker Compose config
+COMPOSE_PROJECT_NAME=benefits
+
 # Amplitude config
 ANALYTICS_KEY=amplitude-api-key
 
@@ -13,7 +16,7 @@ DJANGO_ADMIN=false
 DJANGO_ALLOWED_HOSTS="localhost 127.0.0.1 [::1]"
 DJANGO_DB=django
 DJANGO_DEBUG=true
-DJANGO_INIT_PATH=data/client.json
+DJANGO_INIT_PATH=localhost/data/client.json
 DJANGO_LOCAL_PORT=8000
 DJANGO_LOG_LEVEL=DEBUG
 DJANGO_SECRET_KEY=secret

Dockerfile.dev → localhost/Dockerfile.dev

@@ -3,6 +3,7 @@ FROM benefits_client:latest
 USER root
 
 RUN apt-get install -qq --no-install-recommends curl git jq ssh && \
+    python -m pip install --upgrade pip && \
     pip install --no-cache-dir flake8 debugpy pre-commit
 
 COPY docs/requirements.txt docs/requirements.txt

localhost/README.md

@@ -0,0 +1,22 @@
+# Benefits: `localhost`
+
+Code and artifacts for testing and running the Benefits application in a local, non-production environment.
+
+## [`data/`](./data)
+
+* `client.json`: sample configuration for the Benefits client
+* `server.json`: sample configuration for a local Eligibility Verification server
+
+## [`keys/`](./keys)
+
+* `client.key` and `client.pub`: encryption keypair for the Benefits client
+* `server.key` and `server.pub`: encryption keypair for the local Eligibility Verification server
+
+## [`server/`](./server)
+
+* Simple Flask app implementing Eligiblity Verification server
+
+## [`Dockerfile.dev`](./Dockerfile.dev)
+
+* Docker image built on the [Benefits Docker image](../Dockerfile) used with
+[VS Code devcontainers](https://code.visualstudio.com/docs/remote/containers).

docker-compose.yml → localhost/docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   client:
-    build: .
+    build: ..
     image: benefits_client:latest
     environment:
       - ANALYTICS_KEY
@@ -21,8 +21,8 @@ services:
 
   dev:
     build:
-      context: .
-      dockerfile: Dockerfile.dev
+      context: ..
+      dockerfile: localhost/Dockerfile.dev
     image: benefits_client:dev
     environment:
       - ANALYTICS_KEY
@@ -41,7 +41,7 @@ services:
       - "${DJANGO_LOCAL_PORT}:8000"
       - "5678:5678"
     volumes:
-      - .:/home/calitp/app:cached
+      - ../:/home/calitp/app:cached
 
   docs:
     image: benefits_client:dev
@@ -50,7 +50,7 @@ services:
     ports:
       - "${DOCS_LOCAL_PORT}:8001"
     volumes:
-      - .:/home/calitp/app:cached
+      - ../:/home/calitp/app:cached
 
   server:
     build: ./server

server/app.py → localhost/server/app.py

@@ -216,4 +216,4 @@ def get(self):
 
 
 if __name__ == "__main__":
-    app.run(host="0.0.0.0", debug=True)
+    app.run(host="0.0.0.0", debug=True)  # nosec