feat: pgstac backend (#31)

- Closes #11

Author: gadomski

.github/workflows/ci.yml

@@ -13,6 +13,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: astral-sh/setup-uv@v5
+      - name: Install postgis
+        run: sudo apt-get install postgis
       - name: Install
         run: scripts/install --dev
       - name: Lint

pyproject.toml

@@ -6,21 +6,35 @@ readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
     "fastapi[standard]>=0.115.6",
+    "pgstacrs>=0.1.0",
     "pydantic>=2.10.4",
     "pydantic-settings>=2.7.1",
     "stacrs>=0.3.0",
 ]
 
 [dependency-groups]
-dev = ["mypy>=1.14.1", "pytest>=8.3.4", "pytest-asyncio>=0.25.1", "ruff>=0.8.5"]
+dev = [
+    "mypy>=1.14.1",
+    "psycopg[pool]>=3.2.3",
+    "pypgstac>=0.9.2",
+    "pystac>=1.11.0",
+    "pytest>=8.3.4",
+    "pytest-asyncio>=0.25.1",
+    "pytest-postgresql>=6.1.1",
+    "ruff>=0.8.5",
+]
 
 [tool.mypy]
 strict = true
 files = ["**/*.py"]
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
-asyncio_default_fixture_loop_scope = "function"
+asyncio_default_fixture_loop_scope = "session"
+filterwarnings = [
+    "error",
+    'ignore:datetime.datetime.utcfromtimestamp\(\) is deprecated and scheduled for removal in a future version.:DeprecationWarning',
+]
 
 [tool.ruff.lint]
 select = ["E", "F", "I"]

src/tistac/app.py

@@ -9,7 +9,7 @@
 from .settings import Settings
 
 
-def build(settings: Settings | None = None) -> FastAPI:
+async def build(settings: Settings | None = None) -> FastAPI:
     """Builds a new TiStac application."""
 
     if settings is None:
@@ -18,7 +18,7 @@ def build(settings: Settings | None = None) -> FastAPI:
     async def get_settings() -> Settings:
         return settings
 
-    backend = settings.get_backend()
+    backend = await settings.get_backend()
 
     async def get_backend() -> Backend:
         return backend

src/tistac/pgstac.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from pgstacrs import Client
+
+from .backend import Backend
+from .item_collection import ItemCollection
+from .search import Search
+
+
+class PgstacBackend(Backend):
+    """A PgSTAC backend."""
+
+    @classmethod
+    async def open(cls, dsn: str) -> PgstacBackend:
+        client = await Client.open(dsn)
+        return PgstacBackend(client)
+
+    def __init__(self, client: Client) -> None:
+        self.client = client
+
+    async def search(self, search: Search) -> ItemCollection:
+        item_collection = await self.client.search(limit=search.limit)
+        return ItemCollection.model_validate(item_collection)

src/tistac/settings.py

@@ -1,3 +1,5 @@
+import urllib.parse
+
 from pydantic import Field
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
@@ -14,11 +16,16 @@ class Settings(BaseSettings):
     backend: str
     default_limit: int = Field(default=DEFAULT_LIMIT)
 
-    def get_backend(self) -> Backend:
+    async def get_backend(self) -> Backend:
         """Returns the configured backend."""
+        from .pgstac import PgstacBackend
         from .stac_geoparquet import StacGeoparquetBackend
 
-        return StacGeoparquetBackend(self.backend)
+        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."""

tests/conftest.py

@@ -1,14 +1,66 @@
 from pathlib import Path
+from typing import AsyncIterator
 
 import pytest
+import stacrs
 from fastapi.testclient import TestClient
+from pgstacrs import Client
+from pypgstac.db import PgstacDB
+from pypgstac.migrate import Migrate
+from pystac import Collection, Extent, Item
 from pytest import FixtureRequest
+from pytest_postgresql import factories
+from pytest_postgresql.executor import PostgreSQLExecutor
+from pytest_postgresql.janitor import DatabaseJanitor
 
 import tistac.app
 from tistac import Settings
 
+naip_items = Path(__file__).parents[1] / "data" / "naip.parquet"
 
-@pytest.fixture(params=[str(Path(__file__).parents[1] / "data" / "naip.parquet")])
-def client(request: FixtureRequest) -> TestClient:
-    settings = Settings(backend=request.param)
-    return TestClient(tistac.app.build(settings))
+pgstac_proc = factories.postgresql_proc()
+
+
+@pytest.fixture(scope="session")
+async def pgstac(pgstac_proc: PostgreSQLExecutor) -> AsyncIterator[PostgreSQLExecutor]:
+    dsn = f"postgresql://{pgstac_proc.user}:{pgstac_proc.password}@{pgstac_proc.host}:{pgstac_proc.port}/{pgstac_proc.template_dbname}"
+    pgstac_db = PgstacDB(dsn)
+    Migrate(pgstac_db).run_migration()
+    items = stacrs.read(str(naip_items))["features"][
+        0:100
+    ]  # pgstac takes too long to load 10000 items
+    extent = Extent.from_items((Item.from_dict(d) for d in items))
+    collection = Collection(
+        id="naip", description="Test NAIP collection", extent=extent
+    )
+    client = await Client.open(dsn)
+    await client.create_collection(
+        collection.to_dict(include_self_link=False, transform_hrefs=False)
+    )
+    await client.create_items(items)
+    yield pgstac_proc
+
+
+@pytest.fixture(params=["stac-geoparquet", "pgstac"])
+async def client(
+    request: FixtureRequest, pgstac: PostgreSQLExecutor
+) -> AsyncIterator[TestClient]:
+    if request.param == "stac-geoparquet":
+        settings = Settings(backend=str(naip_items))
+        yield TestClient(await tistac.app.build(settings))
+    elif request.param == "pgstac":
+        with DatabaseJanitor(
+            user=pgstac.user,
+            host=pgstac.host,
+            port=pgstac.port,
+            version=pgstac.version,
+            password=pgstac.password,
+            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))
+    else:
+        raise Exception(f"Unknown backend type: {request.param}")