refactor to ease usage and packaging

.github/workflows/ci.yml

@@ -6,34 +6,33 @@ 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
+      working-directory: ./space2stats_api/src
       run: |
         python -m pip install --upgrade pip
-        pip install -r space2stats_api/src/requirements.txt
-        pip install pre-commit pytest
-
-    - name: Set PYTHONPATH
-      run: echo "PYTHONPATH=$(pwd)/space2stats_api" >> $GITHUB_ENV
+        python -m pip install .["test"]
 
     - name: Run pre-commit
-      run: pre-commit run --all-files
+      run: |
+        python -m pip install pre-commit
+        pre-commit run --all-files
 
     - name: Run tests
-      run: pytest space2stats_api/tests
+      working-directory: ./space2stats_api/src
+      run: python -m pytest -s -vv
+      env:
+        DB_HOST: localhost
+        DB_PORT: 5432
+        DB_NAME: mydatabase
+        DB_USER: myuser
+        DB_PASSWORD: mypassword
+        DB_TABLE_NAME: space2stats

.gitignore

@@ -104,4 +104,6 @@ db.env
 space2stats_api/space2stats_env
 *.env
 cdk.out
-lambda_layer
+lambda_layer
+
+.benchmarks/

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

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(),

space2stats_api/src/README.md

@@ -0,0 +1 @@
+## space2stats

space2stats_api/src/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "space2stats"
+description = "Space 2 Stats"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Zac Deziel", email = "[email protected]"},
+]
+dynamic = ["version"]
+dependencies = [
+    "fastapi>=0.112.0",
+    "pandas",
+    "shapely",
+    "h3",
+    "psycopg[binary]",
+    "psycopg[pool]",
+    "httpx",
+    "geojson-pydantic",
+    "shapely",
+    "pydantic-settings>=2.0.0",
+    "typing_extensions",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-postgresql",
+    "httpx",
+]
+lambda = [
+    "mangum",
+]
+server = [
+    "uvicorn",
+]
+
+[tool.hatch.version]
+path = "space2stats/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+  "/tests",
+  ".pytest_cache",
+  ".local_db.env",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

space2stats_api/src/space2stats/__init__.py

@@ -0,0 +1,5 @@
+"""space2stats."""
+
+from .main import fields, summaries  # noqa
+
+__version__ = "0.1.0"

space2stats_api/src/space2stats/__main__.py

@@ -0,0 +1,23 @@
+
+import os
+
+from .app import app
+
+try:
+    import uvicorn  # noqa
+
+except ImportError:  # pragma: nocover
+    uvicorn = None  # type: ignore
+
+
+if __name__ == "__main__":
+
+    assert uvicorn is not None, "uvicorn must be installed: `python -m pip install 'space2stats[server]'`"
+
+    uvicorn.run(
+        app=app,
+        host=os.getenv("UVICORN_HOST", "127.0.0.1"),
+        port=os.getenv("UVICORN_PORT", "8000"),
+        root_path=os.getenv("UVICORN_ROOT_PATH", ""),
+        log_level="info",
+    )