feat: docker compose (#32)

gadomski · web-flow · commit bf087e6793be · 2025-01-03T14:40:32.000Z
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,4 @@
+.venv
+.*_cache
+node_modules/
+__pycache__
diff --git a/.gitignore b/.gitignore
@@ -171,3 +171,4 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+.vscode/
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,21 @@
+# https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layer
+
+FROM python:3.12-slim AS builder
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+WORKDIR /app
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project --no-build-package stacrs --refresh
+
+ADD . /app
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-editable
+
+FROM python:3.12-slim
+COPY --from=builder --chown=app:app /app/.venv /app/.venv
+
+CMD [ "/app/.venv/bin/uvicorn", "tistac.main:app" ]
diff --git a/README.md b/README.md
@@ -20,7 +20,15 @@ Then:
 scripts/dev
 ```
 
-This will start the server on <http://127.0.0.1:8000/>.
+This will start the **stac-fastapi** server on <http://127.0.0.1:8000/>.
+
+To start both a **pgstac** and **stac-fastapi** server:
+
+```shell
+docker compose up
+```
+
+This will start **pgstac** on <http://127.0.0.1:8000> and **stac-fastapi** on <http://127.0.0.1:8001>.
 
 ## Developing
 
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,41 @@
+services:
+  pgstac:
+    container_name: pgstac
+    image: ghcr.io/stac-utils/pgstac:v0.9.1
+    environment:
+      - POSTGRES_USER=username
+      - POSTGRES_PASSWORD=password
+      - POSTGRES_DB=pgstac
+      - PGUSER=username
+      - PGPASSWORD=password
+      - PGDATABASE=pgstac
+    ports:
+      - 5432:5432
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready", "-d", "pgstac"]
+      interval: 1s
+      timeout: 20s
+      retries: 20
+  tistac-pgstac:
+    container_name: tistac-pgstac
+    build: .
+    environment:
+      - TISTAC_BACKEND=postgresql://username:password@pgstac:5432/pgstac
+      - UVICORN_HOST=0.0.0.0
+      - UVICORN_PORT=8000
+    ports:
+      - 8000:8000
+    depends_on:
+      pgstac:
+        condition: service_healthy
+  tistac-stac-fastapi:
+    container_name: tistac-stac-fastapi
+    build: .
+    environment:
+      - TISTAC_BACKEND=/app/data/naip.parquet
+      - UVICORN_HOST=0.0.0.0
+      - UVICORN_PORT=8001
+    ports:
+      - 8001:8001
+    volumes:
+      - ./data:/app/data
diff --git a/main.py b/main.py
diff --git a/scripts/dev b/scripts/dev
@@ -2,4 +2,4 @@
 
 set -e
 
-TISTAC_BACKEND=data/naip.parquet uv run fastapi dev
+TISTAC_BACKEND=data/naip.parquet uv run fastapi dev src/tistac/main.py
diff --git a/src/tistac/app.py b/src/tistac/app.py
diff --git a/src/tistac/backends/__init__.py b/src/tistac/backends/__init__.py
@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 
-from .item_collection import ItemCollection
-from .search import Search
+from tistac.models.item_collection import ItemCollection
+from tistac.models.search import Search
 
 
 class Backend(ABC):
diff --git a/src/tistac/backends/pgstac.py b/src/tistac/backends/pgstac.py
@@ -2,9 +2,9 @@
 
 from pgstacrs import Client
 
-from .backend import Backend
-from .item_collection import ItemCollection
-from .search import Search
+from tistac.backends import Backend
+from tistac.models.item_collection import ItemCollection
+from tistac.models.search import Search
 
 
 class PgstacBackend(Backend):
diff --git a/src/tistac/backends/stac_geoparquet.py b/src/tistac/backends/stac_geoparquet.py
@@ -1,8 +1,8 @@
 import stacrs
 
-from .backend import Backend
-from .item_collection import ItemCollection
-from .search import Search
+from tistac.backends import Backend
+from tistac.models.item_collection import ItemCollection
+from tistac.models.search import Search
 
 
 class StacGeoparquetBackend(Backend):
diff --git a/src/tistac/dependencies.py b/src/tistac/dependencies.py
@@ -0,0 +1,24 @@
+import urllib.parse
+from functools import lru_cache
+from typing import Annotated
+
+from fastapi import Depends
+
+from tistac.backends import Backend
+from tistac.backends.pgstac import PgstacBackend
+from tistac.backends.stac_geoparquet import StacGeoparquetBackend
+from tistac.settings import Settings
+
+
+@lru_cache
+def get_settings() -> Settings:
+    return Settings()  # type: ignore
+
+
+async def get_backend(settings: Annotated[Settings, Depends(get_settings)]) -> Backend:
+    # TODO share the pgstac connection pool
+    url = urllib.parse.urlparse(settings.backend)
+    if url.scheme == "postgresql":
+        return await PgstacBackend.open(settings.backend)
+    else:
+        return StacGeoparquetBackend(settings.backend)
diff --git a/src/tistac/main.py b/src/tistac/main.py
@@ -0,0 +1,6 @@
+from fastapi import FastAPI
+
+import tistac.router
+
+app = FastAPI()
+app.include_router(tistac.router.router)
diff --git a/src/tistac/models/__init__.py b/src/tistac/models/__init__.py
diff --git a/src/tistac/models/item_collection.py b/src/tistac/models/item_collection.py
diff --git a/src/tistac/models/page.py b/src/tistac/models/page.py
@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+
+class Page(BaseModel):
+    """A page of a search response.
+
+    Not exactly an item collection, but close.
+    """
diff --git a/src/tistac/models/root.py b/src/tistac/models/root.py
diff --git a/src/tistac/models/search.py b/src/tistac/models/search.py
diff --git a/src/tistac/router.py b/src/tistac/router.py
@@ -0,0 +1,42 @@
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, Query
+
+from tistac.backends import Backend
+from tistac.dependencies import get_backend, get_settings
+from tistac.models.item_collection import ItemCollection
+from tistac.models.root import Root
+from tistac.models.search import GetSearch, Search
+from tistac.settings import Settings
+
+router = APIRouter()
+
+
+@router.get("/")
+async def root() -> Root:
+    """The STAC API root."""
+
+    return Root()
+
+
+@router.get("/search")
+async def get_search(
+    get_search: Annotated[GetSearch, Query()],
+    backend: Annotated[Backend, Depends(get_backend)],
+    settings: Annotated[Settings, Depends(get_settings)],
+) -> ItemCollection:
+    """Searches this STAC API via a GET request."""
+    search = get_search.into_search()
+    search = settings.update_search(search)
+    return await backend.search(search)
+
+
+@router.post("/search")
+async def post_search(
+    search: Search,
+    backend: Annotated[Backend, Depends(get_backend)],
+    settings: Annotated[Settings, Depends(get_settings)],
+) -> ItemCollection:
+    """Searches this STAC API via a POST request."""
+    search = settings.update_search(search)
+    return await backend.search(search)
diff --git a/src/tistac/settings.py b/src/tistac/settings.py
@@ -1,11 +1,8 @@
-import urllib.parse
-
 from pydantic import Field
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
-from .backend import Backend
-from .constants import DEFAULT_LIMIT
-from .search import Search
+from tistac.constants import DEFAULT_LIMIT
+from tistac.models.search import Search
 
 
 class Settings(BaseSettings):
@@ -16,17 +13,6 @@ class Settings(BaseSettings):
     backend: str
     default_limit: int = Field(default=DEFAULT_LIMIT)
 
-    async def get_backend(self) -> Backend:
-        """Returns the configured backend."""
-        from .pgstac import PgstacBackend
-        from .stac_geoparquet import StacGeoparquetBackend
-
-        url = urllib.parse.urlparse(self.backend)
-        if url.scheme == "postgresql":
-            return await PgstacBackend.open(self.backend)
-        else:
-            return StacGeoparquetBackend(self.backend)
-
     def update_search(self, search: Search) -> Search:
         """Updates a search with some default settings."""
         if search.limit is None:
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -13,11 +13,10 @@
 from pytest_postgresql.executor import PostgreSQLExecutor
 from pytest_postgresql.janitor import DatabaseJanitor
 
-import tistac.app
 from tistac import Settings
+from tistac.dependencies import get_settings
 
 naip_items = Path(__file__).parents[1] / "data" / "naip.parquet"
-
 pgstac_proc = factories.postgresql_proc()
 
 
@@ -45,9 +44,15 @@ async def pgstac(pgstac_proc: PostgreSQLExecutor) -> AsyncIterator[PostgreSQLExe
 async def client(
     request: FixtureRequest, pgstac: PostgreSQLExecutor
 ) -> AsyncIterator[TestClient]:
+    from tistac.main import app
+
     if request.param == "stac-geoparquet":
-        settings = Settings(backend=str(naip_items))
-        yield TestClient(await tistac.app.build(settings))
+
+        def get_settings_override() -> Settings:
+            return Settings(backend=str(naip_items))
+
+        app.dependency_overrides[get_settings] = get_settings_override
+        yield TestClient(app)
     elif request.param == "pgstac":
         with DatabaseJanitor(
             user=pgstac.user,
@@ -58,9 +63,13 @@ async def client(
             dbname="pypgstac_test",
             template_dbname=pgstac.template_dbname,
         ) as database_janitor:
-            settings = Settings(
-                backend=f"postgresql://{database_janitor.user}:{database_janitor.password}@{database_janitor.host}:{database_janitor.port}/{database_janitor.dbname}"
-            )
-            yield TestClient(await tistac.app.build(settings))
+
+            def get_settings_override() -> Settings:
+                return Settings(
+                    backend=f"postgresql://{database_janitor.user}:{database_janitor.password}@{database_janitor.host}:{database_janitor.port}/{database_janitor.dbname}"
+                )
+
+            app.dependency_overrides[get_settings] = get_settings_override
+            yield TestClient(app)
     else:
         raise Exception(f"Unknown backend type: {request.param}")
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -171,3 +171,4 @@ cython_debug/`
`171`	`171`
`172`	`172`	`# PyPI configuration file`
`173`	`173`	`.pypirc`
	`174`	`+.vscode/`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`set -e`
`4`	`4`
`5`		`-TISTAC_BACKEND=data/naip.parquet uv run fastapi dev`
	`5`	`+TISTAC_BACKEND=data/naip.parquet uv run fastapi dev src/tistac/main.py`