Merge pull request #406 from CodeForPhilly/develop

Release: v1.1.0

Author: themightychris

.github/workflows/containers-publish.yml

@@ -1,8 +1,8 @@
 name: "Containers: Publish"
 
 on:
-  push:
-    tags: ["v*"]
+  release:
+    types: [published]
 
 permissions:
   packages: write
@@ -12,10 +12,10 @@ jobs:
     name: Build and Push
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
 
       - name: Login to ghcr.io Docker registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}

.github/workflows/python-app.yml

@@ -0,0 +1,29 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "listOfMed" ]
+  pull_request:
+    branches: [ "listOfMed" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Install the code linting and formatting tool Ruff
+      run: pipx install ruff
+    - name: Lint code with Ruff
+      run: ruff check --output-format=github --target-version=py39

README.md

@@ -36,15 +36,29 @@ Tools used for development:
 
 ### Running Balancer for development
 
-Running Balancer:
-- Start Docker Desktop and run `docker compose up --build` 
-- The email and password are set in `server/api/management/commands/createsu.py`
-- Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/) 
+Start the Postgres, Django REST, and React services by starting Docker Desktop and running `docker compose up --build` 
 
-Running pgAdmin:
+#### Postgres
+- Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/) 
 - The email and password of `pgAdmin` are specified in `balancer-main/docker-compose.yml`
-- The first time you use `pgAdmin` after building the Docker containers you will need to register the server. 
-The `Host name/address`, `Username` and `Password` are specified in  `balancer-main/docker-compose.yml`
+- The first time you use `pgAdmin` after building the Docker containers you will need to register the server.
+    - The `Host name/address` is the Postgres server service name in the Docker Compose file
+    - The `Username` and `Password` are the Postgres server environment variables in the Docker Compose file
+- You can use the below code snippet to  query the database from a Jupyter notebook: 
+
+```
+from sqlalchemy import create_engine
+import pandas as pd
+
+engine = create_engine("postgresql+psycopg2://balancer:balancer@localhost:5433/balancer_dev")
+
+query = "SELECT * FROM api_embeddings;"
+
+df = pd.read_sql(query, engine)
+```
+
+#### Django REST
+- The email and password are set in `server/api/management/commands/createsu.py`
 
 ## Local Kubernetes Deployment
 

deploy/manifests/balancer/base/deployment.yml

@@ -17,7 +17,7 @@ spec:
         app: balancer
     spec:
       containers:
-        - image: chrissst/balancer
+        - image: ghcr.io/codeforphilly/balancer-main/backend
           name: balancer
           envFrom:
             - configMapRef:

deploy/manifests/balancer/overlays/dev/kustomization.yml

@@ -5,7 +5,7 @@ resources:
   - "../../base"
 
 images:
-  - name: chrissst/balancer
-    newTag: v1
-
+  - name: ghcr.io/codeforphilly/balancer-main/backend
+    newTag: "1.0.2"
+    
 namespace: balancer

docker-compose.yml

@@ -1,34 +1,34 @@
 services:
   db:
-      build:
-        context: ./db
-        dockerfile: Dockerfile
-      volumes:
-        - postgres_data:/var/lib/postgresql/data/
-      environment:
-        - POSTGRES_USER=balancer
-        - POSTGRES_PASSWORD=balancer
-        - POSTGRES_DB=balancer_dev
-      ports:
-      - "5433:5432"
-      networks:
-        app_net:
-          ipv4_address: 192.168.0.2  
-  pgadmin:
-    container_name: pgadmin4
-    image: dpage/pgadmin4
+    build:
+      context: ./db
+      dockerfile: Dockerfile
+    volumes:
+      - postgres_data:/var/lib/postgresql/data/
     environment:
-      PGADMIN_DEFAULT_EMAIL: [email protected]
-      PGADMIN_DEFAULT_PASSWORD: balancer
-      # PGADMIN_LISTEN_PORT = 80
-    # volumes:
-    #   - ./pgadmin-data:/var/lib/pgadmin
-    #       # PGADMIN_LISTEN_PORT = 80
+      - POSTGRES_USER=balancer
+      - POSTGRES_PASSWORD=balancer
+      - POSTGRES_DB=balancer_dev
     ports:
-      - "5050:80"
+      - "5433:5432"
     networks:
       app_net:
-        ipv4_address: 192.168.0.4
+        ipv4_address: 192.168.0.2
+  # pgadmin:
+  #   container_name: pgadmin4
+  #   image: dpage/pgadmin4
+  #   environment:
+  #     PGADMIN_DEFAULT_EMAIL: [email protected]
+  #     PGADMIN_DEFAULT_PASSWORD: balancer
+  #     # PGADMIN_LISTEN_PORT = 80
+  #   # volumes:
+  #   #   - ./pgadmin-data:/var/lib/pgadmin
+  #   #       # PGADMIN_LISTEN_PORT = 80
+  #   ports:
+  #     - "5050:80"
+  #   networks:
+  #     app_net:
+  #       ipv4_address: 192.168.0.4
   backend:
     image: balancer-backend
     build: ./server
@@ -52,13 +52,13 @@ services:
       args:
         - IMAGE_NAME=balancer-frontend
     ports:
-        - "3000:3000"
+      - "3000:3000"
     environment:
-        - CHOKIDAR_USEPOLLING=true
-        # - VITE_API_BASE_URL=https://balancertestsite.com/
+      - CHOKIDAR_USEPOLLING=true
+      # - VITE_API_BASE_URL=https://balancertestsite.com/
     volumes:
-        - "./frontend:/usr/src/app:delegated"
-        - "/usr/src/app/node_modules/"
+      - "./frontend:/usr/src/app:delegated"
+      - "/usr/src/app/node_modules/"
     depends_on:
       - backend
     networks:
@@ -72,4 +72,4 @@ networks:
       driver: default
       config:
         - subnet: "192.168.0.0/24"
-          gateway: 192.168.0.1
+          gateway: 192.168.0.1