refactor to ease usage and packaging (#32)

* refactor to ease usage and packaging * Update .gitignore * add open=True to avoid deprecation * add compression middleware * switch to orjson * Use poetry for dependency management given lambda deployment * Update CI for poetry dependency management * Add pre-commit to poetry test dependencies * Run pip through python --------- Co-authored-by: Zachary Deziel <zachary.deziel@gmail.com>
worldbank · Aug 30, 2024 · 4b51bb4 · 4b51bb4
1 parent 49b7f2a
commit 4b51bb4
Show file tree

Hide file tree

Showing 31 changed files with 2,499 additions and 288 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,34 +6,38 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
-    env:
-      DB_HOST: localhost
-      DB_PORT: 5432
-      DB_NAME: mydatabase
-      DB_USER: myuser
-      DB_PASSWORD: mypassword
-      DB_TABLE_NAME: space2stats
-
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: 3.11
 
-    - name: Install dependencies
+    - name: Install Poetry
       run: |
         python -m pip install --upgrade pip
-        pip install -r space2stats_api/src/requirements.txt
-        pip install pre-commit pytest
+        python -m pip install poetry
 
-    - name: Set PYTHONPATH
-      run: echo "PYTHONPATH=$(pwd)/space2stats_api" >> $GITHUB_ENV
+    - name: Install dependencies
+      working-directory: ./space2stats_api/src
+      run: |
+        poetry install --with test
 
     - name: Run pre-commit
-      run: pre-commit run --all-files
+      working-directory: ./space2stats_api/src
+      run: |
+        poetry run pre-commit run --all-files
 
     - name: Run tests
-      run: pytest space2stats_api/tests
+      working-directory: ./space2stats_api/src
+      run: |
+        poetry run pytest -s -vv
+      env:
+        DB_HOST: localhost
+        DB_PORT: 5432
+        DB_NAME: mydatabase
+        DB_USER: myuser
+        DB_PASSWORD: mypassword
+        DB_TABLE_NAME: space2stats
diff --git a/.gitignore b/.gitignore
@@ -104,4 +104,4 @@ db.env
 space2stats_api/space2stats_env
 *.env
 cdk.out
-lambda_layer
+lambda_layer
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -2,16 +2,17 @@ version: '3'
 
 services:
   database:
-    image: ghcr.io/stac-utils/pgstac:v0.8.5
+    # at time of writing this, ARM64 is not supported so we make sure to use
+    # a supported platform: https://github.com/postgis/docker-postgis/issues/216
+    # Could possibly switch to https://github.com/vincentsarago/containers
+    platform: linux/amd64
+    image: postgis/postgis:15-3.4
     environment:
       - POSTGRES_USER=username
       - POSTGRES_PASSWORD=password
       - POSTGRES_DB=postgis
-      - PGUSER=username
-      - PGPASSWORD=password
-      - PGDATABASE=postgis
     ports:
       - "${MY_DOCKER_IP:-127.0.0.1}:5439:5432"
     command: postgres -N 500
     volumes:
-      - ./.pgdata:/var/lib/postgresql/data
+      - ./.pgdata:/var/lib/postgresql/data
diff --git a/space2stats_api/cdk/aws_stack.py b/space2stats_api/cdk/aws_stack.py
@@ -19,7 +19,7 @@ def __init__(self, scope: Construct, id: str, **kwargs) -> None:
             self, "Space2StatsFunction",
             entry="../src",
             runtime=_lambda.Runtime.PYTHON_3_11,
-            index="app/main.py",
+            index="space2stats/handler.py",
             timeout=Duration.seconds(120),
             handler="handler",
             environment=app_settings.model_dump(),

diff --git a/space2stats_api/local_db.env b/space2stats_api/local_db.env
diff --git a/space2stats_api/pytest.ini b/space2stats_api/pytest.ini
diff --git a/space2stats_api/src/LICENSE b/space2stats_api/src/LICENSE
diff --git a/space2stats_api/src/README.md b/space2stats_api/src/README.md
@@ -0,0 +1 @@
+## space2stats
diff --git a/space2stats_api/src/app/__init__.py b/space2stats_api/src/app/__init__.py
diff --git a/space2stats_api/src/app/main.py b/space2stats_api/src/app/main.py
diff --git a/space2stats_api/src/app/routers/__init__.py b/space2stats_api/src/app/routers/__init__.py
diff --git a/space2stats_api/src/app/routers/api.py b/space2stats_api/src/app/routers/api.py
diff --git a/space2stats_api/src/app/settings.py b/space2stats_api/src/app/settings.py
diff --git a/space2stats_api/src/app/utils/__init__.py b/space2stats_api/src/app/utils/__init__.py
diff --git a/space2stats_api/src/app/utils/db_utils.py b/space2stats_api/src/app/utils/db_utils.py