rename packages

Author: c-wygoda

.github/workflows/release.yml

@@ -33,8 +33,8 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            ghcr.io/stat-utils/stat-fastapi
-            ${{ vars.AWS_ECR_URI }}/stat-utils/stat-fastapi
+            ghcr.io/stapi-spec/stapi-fastapi
+            ${{ vars.AWS_ECR_URI }}/stapi-spec/stapi-fastapi
       - name: Build and push
         uses: docker/build-push-action@v5
         with:

Dockerfile

@@ -10,15 +10,15 @@ RUN pip install --no-cache-dir --no-cache poetry
 
 WORKDIR /app
 
-COPY poetry.lock pyproject.toml .
+COPY poetry.lock pyproject.toml ./
 
 RUN python3 -m venv /.venv && poetry install --no-cache --no-interaction --with lambda
 RUN apt-get -yq update && apt-get -yq install git && pip install \
-    # git+https://github.com/stat-utils/stat-fastapi-up42.git@main \
-    git+https://github.com/stat-utils/stat-fastapi-blacksky.git@main \
-    git+https://github.com/stat-utils/stat-fastapi-umbra.git@main \
+    # git+https://github.com/stapi-utils/stat-fastapi-up42.git@main \
+    git+https://github.com/stapi-utils/stat-fastapi-blacksky.git@main \
+    git+https://github.com/stapi-utils/stat-fastapi-umbra.git@main \
     && rm -rf /var/lib/apt/lists/*
 
 COPY . /app
 
-RUN poetry run python -c "import compileall; compileall.compile_path(maxlevels=10)" && poetry run python -m compileall stat_fastapi
+RUN poetry run python -c "import compileall; compileall.compile_path(maxlevels=10)" && poetry run python -m compileall stapi_fastapi

README.md

@@ -1,13 +1,13 @@
-# STAT FastAPI - SpatioTemporal Asset Tasking with FastAPI
+# STAPI FastAPI - Sensor Tasking API with FastAPI
 
-WARNING: The whole [STAT spec](https://github.com/stapi-spec/stapi-spec) is very much work in progress, so things are
+WARNING: The whole [STAPI spec](https://github.com/stapi-spec/stapi-spec) is very much work in progress, so things are
 guaranteed to be not correct.
 
 NOTE: This repository uses [scripts to rule them all](https://github.com/github/scripts-to-rule-them-all)
 
 ## Usage
 
-STAT FastAPI provides an `fastapi.APIRouter` which must be included in
+STAPI FastAPI provides an `fastapi.APIRouter` which must be included in
 `fastapi.FastAPI` instance.
 
 ## Development
@@ -35,7 +35,7 @@ pytest flags are passed along
 
 ### Dev Server
 
-For dev purposes, [stat_fastapi.**dev**.py](./stat_fastapi/__dev__.py) shows
+For dev purposes, [stapi_fastapi.**dev**.py](./stapi_fastapi/__dev__.py) shows
 a minimal demo with `uvicorn` to run the full app. Start it with `./scripts/server`.
 
 ### Implementing a backend

conftest.py

@@ -5,8 +5,8 @@
 from fastapi.testclient import TestClient
 from pytest import Parser, fixture
 
-from stat_fastapi.api import StatApiRouter
-from stat_fastapi_test_backend import TestBackend
+from stapi_fastapi.api import StapiRouter
+from stapi_fastapi_test_backend import TestBackend
 
 T = TypeVar("T")
 
@@ -15,30 +15,30 @@
 
 def pytest_addoption(parser: Parser):
     parser.addoption(
-        "--stat-backend",
+        "--stapi-backend",
         action="store",
-        default="stat_fastapi_test_backend:TestBackend",
+        default="stapi_fastapi_test_backend:TestBackend",
     )
-    parser.addoption("--stat-prefix", action="store", default="/stat")
-    parser.addoption("--stat-product-id", action="store", default="mock:standard")
+    parser.addoption("--stapi-prefix", action="store", default="/stapi")
+    parser.addoption("--stapi-product-id", action="store", default="mock:standard")
 
 
 @fixture(scope="session")
 def base_url() -> YieldFixture[str]:
-    yield "http://statserver"
+    yield "http://stapiserver"
 
 
 @fixture
-def stat_backend():
+def stapi_backend():
     yield TestBackend()
 
 
 @fixture
-def stat_client(stat_backend, base_url: str) -> YieldFixture[TestClient]:
+def stapi_client(stapi_backend, base_url: str) -> YieldFixture[TestClient]:
     app = FastAPI()
 
     app.include_router(
-        StatApiRouter(backend=stat_backend).router,
+        StapiRouter(backend=stapi_backend).router,
         prefix="",
     )
 

lambda_handler.py

@@ -3,26 +3,26 @@
 from fastapi import FastAPI
 from mangum import Mangum
 
-from stat_fastapi.api import StatApiRouter
-from stat_fastapi.backend import StatApiBackend
+from stapi_fastapi.api import StapiRouter
+from stapi_fastapi.backend import StapiBackend
 
 
-def get_backend(name: str) -> StatApiBackend:
+def get_backend(name: str) -> StapiBackend:
     match name:
         case "landsat":
-            from stat_fastapi_landsat import StatLandsatBackend
+            from stapi_fastapi_landsat import LandsatBackend
 
-            return StatLandsatBackend()
+            return LandsatBackend()
         case "blacksky":
-            from stat_fastapi_blacksky import BlackskyBackend
+            from stapi_fastapi_blacksky import BlackskyBackend
 
             return BlackskyBackend()
         case "up42":
-            from stat_fastapi_up42 import StatUp42Backend
+            from stapi_fastapi_up42 import StatUp42Backend
 
             return StatUp42Backend()
         case "umbra":
-            from stat_fastapi_umbra import UmbraBackend
+            from stapi_fastapi_umbra import UmbraBackend
 
             return UmbraBackend()
         case _:
@@ -31,7 +31,7 @@ def get_backend(name: str) -> StatApiBackend:
 
 app = FastAPI()
 app.include_router(
-    StatApiRouter(backend=get_backend(os.environ.get("BACKEND_NAME", "landsat"))).router
+    StapiRouter(backend=get_backend(os.environ.get("BACKEND_NAME", "landsat"))).router
 )
 
 handler = Mangum(app, lifespan="off")

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "stat-fastapi"
+name = "stapi-fastapi"
 version = "0.0.0"
 description = "Spatio Temporal Asset Tasking with FastAPI"
 authors = ["Christian Wygoda <[email protected]>"]
@@ -39,8 +39,8 @@ constructs = "^10.3.0"
 pydantic-settings = "^2.2.1"
 
 [tool.poetry.scripts]
-dev = "stat_fastapi.__dev__:cli"
-landsat = "stat_fastapi_landsat.__dev__:cli"
+dev = "stapi_fastapi.__dev__:cli"
+landsat = "stapi_fastapi_landsat.__dev__:cli"
 
 [tool.ruff]
 line-length = 88
@@ -66,11 +66,11 @@ sort = "Cover"
 omit = [
     "**/*_test.py",
     "**/conftest.py",
-    "stat_fastapi/__dev__.py",
+    "stapi_fastapi/__dev__.py",
 ]
 
 [tool.pytest.ini_options]
-addopts="--cov=stat_fastapi"
+addopts="--cov=stapi_fastapi"
 filterwarnings = [
     "ignore:The 'app' shortcut is now deprecated.:DeprecationWarning",
     "ignore:Pydantic serializer warnings:UserWarning",

stat_fastapi/__dev__.py stapi_fastapi/__dev__.pystat_fastapi/__dev__.py renamed to stapi_fastapi/__dev__.py

@@ -11,8 +11,8 @@
     print("install uvicorn and pydantic-settings to use the dev server", file=stderr)
     exit(1)
 
-from stat_fastapi.api import StatApiRouter
-from stat_fastapi_tle_backend import StatMockBackend
+from stapi_fastapi.api import StapiRouter
+from stapi_fastapi_tle_backend import StapiMockBackend
 
 
 class DevSettings(BaseSettings):
@@ -21,9 +21,11 @@ class DevSettings(BaseSettings):
 
 
 app = FastAPI(debug=True)
-app.include_router(StatApiRouter(backend=StatMockBackend()).router)
+app.include_router(StapiRouter(backend=StapiMockBackend()).router)
 
 
 def cli():
     settings = DevSettings()
-    run("stat_fastapi.__dev__:app", reload=True, host=settings.host, port=settings.port)
+    run(
+        "stapi_fastapi.__dev__:app", reload=True, host=settings.host, port=settings.port
+    )

stat_fastapi/__init__.py stapi_fastapi/__init__.pystat_fastapi/__init__.py renamed to stapi_fastapi/__init__.py

@@ -2,35 +2,35 @@
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import JSONResponse
 
-from stat_fastapi.backend import StatApiBackend
-from stat_fastapi.constants import TYPE_GEOJSON, TYPE_JSON
-from stat_fastapi.exceptions import ConstraintsException, NotFoundException
-from stat_fastapi.models.opportunity import (
+from stapi_fastapi.backend import StapiBackend
+from stapi_fastapi.constants import TYPE_GEOJSON, TYPE_JSON
+from stapi_fastapi.exceptions import ConstraintsException, NotFoundException
+from stapi_fastapi.models.opportunity import (
     OpportunityCollection,
     OpportunityRequest,
 )
-from stat_fastapi.models.order import Order
-from stat_fastapi.models.product import Product, ProductsCollection
-from stat_fastapi.models.root import RootResponse
-from stat_fastapi.models.shared import HTTPException as HTTPExceptionModel
-from stat_fastapi.models.shared import Link
+from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.product import Product, ProductsCollection
+from stapi_fastapi.models.root import RootResponse
+from stapi_fastapi.models.shared import HTTPException as HTTPExceptionModel
+from stapi_fastapi.models.shared import Link
 
 
-class StatApiException(HTTPException):
+class StapiException(HTTPException):
     def __init__(self, status_code: int, detail: str) -> None:
         super().__init__(status_code, detail)
 
 
-class StatApiRouter:
-    NAME_PREFIX = "stat"
-    backend: StatApiBackend
+class StapiRouter:
+    NAME_PREFIX = "stapi"
+    backend: StapiBackend
     openapi_endpoint_name: str
     docs_endpoint_name: str
     router: APIRouter
 
     def __init__(
         self,
-        backend: StatApiBackend,
+        backend: StapiBackend,
         openapi_endpoint_name="openapi",
         docs_endpoint_name="swagger_ui_html",
         *args,
@@ -93,12 +93,12 @@ def root(self, request: Request) -> RootResponse:
         return RootResponse(
             links=[
                 Link(
-                    href=str(request.url_for("stat:root")),
+                    href=str(request.url_for(f"{self.NAME_PREFIX}:root")),
                     rel="self",
                     type=TYPE_JSON,
                 ),
                 Link(
-                    href=str(request.url_for("stat:list-products")),
+                    href=str(request.url_for(f"{self.NAME_PREFIX}:list-products")),
                     rel="products",
                     type=TYPE_JSON,
                 ),
@@ -121,7 +121,9 @@ def products(self, request: Request) -> ProductsCollection:
             product.links.append(
                 Link(
                     href=str(
-                        request.url_for("stat:get-product", product_id=product.id)
+                        request.url_for(
+                            f"{self.NAME_PREFIX}:get-product", product_id=product.id
+                        )
                     ),
                     rel="self",
                     type=TYPE_JSON,
@@ -131,7 +133,7 @@ def products(self, request: Request) -> ProductsCollection:
             products=products,
             links=[
                 Link(
-                    href=str(request.url_for("stat:list-products")),
+                    href=str(request.url_for(f"{self.NAME_PREFIX}:list-products")),
                     rel="self",
                     type=TYPE_JSON,
                 )
@@ -142,12 +144,16 @@ def product(self, product_id: str, request: Request) -> Product:
         try:
             product = self.backend.product(product_id, request)
         except NotFoundException as exc:
-            raise StatApiException(
+            raise StapiException(
                 status.HTTP_404_NOT_FOUND, "product not found"
             ) from exc
         product.links.append(
             Link(
-                href=str(request.url_for("stat:get-product", product_id=product.id)),
+                href=str(
+                    request.url_for(
+                        f"{self.NAME_PREFIX}:get-product", product_id=product.id
+                    )
+                ),
                 rel="self",
                 type=TYPE_JSON,
             )

stat_fastapi/api.py stapi_fastapi/api.pystat_fastapi/api.py renamed to stapi_fastapi/api.py

@@ -2,12 +2,12 @@
 
 from fastapi import Request
 
-from stat_fastapi.models.opportunity import Opportunity, OpportunityRequest
-from stat_fastapi.models.order import Order
-from stat_fastapi.models.product import Product
+from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
+from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.product import Product
 
 
-class StatApiBackend(Protocol):
+class StapiBackend(Protocol):
     def products(self, request: Request) -> list[Product]:
         """
         Return a list of supported products.
@@ -26,21 +26,21 @@ async def search_opportunities(
         Search for ordering opportunities for the  given search parameters.
 
         Backends must validate search constraints and raise
-        `stat_fastapi.backend.exceptions.ConstraintsException` if not valid.
+        `stapi_fastapi.backend.exceptions.ConstraintsException` if not valid.
         """
 
     async def create_order(self, search: OpportunityRequest, request: Request) -> Order:
         """
         Create a new order.
 
         Backends must validate order payload and raise
-        `stat_fastapi.backend.exceptions.ConstraintsException` if not valid.
+        `stapi_fastapi.backend.exceptions.ConstraintsException` if not valid.
         """
 
     async def get_order(self, order_id: str, request: Request) -> Order:
         """
         Get details for order with `order_id`.
 
-        Backends must raise `stat_fastapi.backend.exceptions.NotFoundException`
+        Backends must raise `stapi_fastapi.backend.exceptions.NotFoundException`
         if not found or access denied.
         """