interloper-api 0.112.0__tar.gz → 0.113.0__tar.gz

{interloper_api-0.112.0 → interloper_api-0.113.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: interloper-api
-Version: 0.112.0
+Version: 0.113.0
 Summary: Interloper FastAPI routes
 Author: Guillaume Onfroy
 Author-email: Guillaume Onfroy <guillaume@digitlcloud.com>

{interloper_api-0.112.0 → interloper_api-0.113.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "interloper-api"
-version = "0.112.0"
+version = "0.113.0"
 description = "Interloper FastAPI routes"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -26,6 +26,9 @@ otel = [
     "opentelemetry-instrumentation-fastapi>=0.65b0",
 ]
 
+[project.entry-points."interloper.cli"]
+api = "interloper_api.cli:register"
+
 [build-system]
 requires = ["uv_build>=0.12.9,<0.13"]
 build-backend = "uv_build"

{interloper_api-0.112.0 → interloper_api-0.113.0}/pyproject.toml.orig

@@ -3,7 +3,7 @@
 # ###############
 [project]
 name = "interloper-api"
-version = "0.112.0"
+version = "0.113.0"
 description = "Interloper FastAPI routes"
 readme = "README.md"
 authors = [{ name = "Guillaume Onfroy", email = "guillaume@digitlcloud.com" }]
@@ -26,6 +26,9 @@ otel = [
     "opentelemetry-instrumentation-fastapi>=0.65b0",
 ]
 
+[project.entry-points."interloper.cli"]
+api = "interloper_api.cli:register"
+
 [build-system]
 requires = ["uv_build>=0.12.9,<0.13"]
 build-backend = "uv_build"

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/__init__.py

@@ -1,5 +1,6 @@
 """HTTP API for interloper: catalog, collection, run, and auth endpoints."""
 
 from interloper_api.app import create_app
+from interloper_api.server import ApiServer
 
-__all__ = ["create_app"]
+__all__ = ["ApiServer", "create_app"]

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/app.py

@@ -9,17 +9,17 @@ from typing import Any
 from fastapi import APIRouter, FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse
-from interloper.catalog.base import Catalog
-from interloper.errors import (
+from interloper.catalog import Catalog
+from interloper.errors import ConfigError
+from interloper_db import (
     ComponentDriftError,
-    ConfigError,
     ConflictError,
     HydrationError,
     InUseError,
     NotFoundError,
     QuotaExceededError,
+    Store,
 )
-from interloper_db import Store
 
 from interloper_api.dependencies import (
     set_admin_config,

interloper_api-0.113.0/src/interloper_api/cli.py

@@ -0,0 +1,62 @@
+"""``interloper api``: serve the HTTP API, the api role's command."""
+
+from __future__ import annotations
+
+import argparse
+import logging
+
+from interloper.catalog import Catalog
+from interloper.cli.console import configure_console_logging
+from interloper.settings import AppSettings
+from interloper.utils import Supervisor
+from interloper_db import Store
+from interloper_db.provision import bootstrap
+
+from interloper_api.server import ApiServer
+
+
+def register(subparsers: argparse._SubParsersAction) -> None:
+    """Register the ``api`` command.
+
+    Args:
+        subparsers: The root subparsers action to attach to.
+    """
+    parser = subparsers.add_parser(
+        "api",
+        help="Serve the HTTP API",
+        description="Serve the HTTP API. The frontend is served separately: by nginx in containers, by "
+        "`interloper app` locally.",
+    )
+    parser.add_argument("--host", default=None, help="Bind host (default: server.host, 0.0.0.0)")
+    parser.add_argument("--port", type=int, default=None, help="Bind port (default: server.port, 3000)")
+    parser.add_argument(
+        "--no-create-tables",
+        action="store_true",
+        default=False,
+        help="Skip CREATE TABLE bootstrap on startup (production: run `interloper db init` once instead)",
+    )
+    parser.set_defaults(handler=_cmd_api)
+
+
+def _cmd_api(args: argparse.Namespace) -> None:
+    """Serve the API until a signal or its death.
+
+    Args:
+        args: Parsed CLI arguments: ``host``, ``port`` and ``no_create_tables``.
+    """
+    settings = AppSettings.get()
+    if args.host is not None:
+        settings = settings.model_copy(update={"server": settings.server.model_copy(update={"host": args.host})})
+        AppSettings.activate(settings)
+    configure_console_logging(
+        logging.INFO, "%(asctime)s %(name)s %(levelname)s %(message)s", log_format=settings.log.format
+    )
+    bootstrap(
+        settings.postgres.dsn,
+        statement_timeout=settings.postgres.statement_timeout,
+        create_tables=not args.no_create_tables,
+    )
+    catalog = Catalog.from_settings()
+    store = Store.from_settings(catalog=catalog)
+    port = settings.server.port if args.port is None else args.port
+    Supervisor({"api": ApiServer.from_settings(settings, store=store, catalog=catalog, port=port)}).run()

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/dependencies/rbac.py

@@ -7,8 +7,7 @@ from typing import Annotated, Any
 from uuid import UUID
 
 from fastapi import Depends, HTTPException
-from interloper.errors import NotFoundError
-from interloper_db import Profile, Role, Store
+from interloper_db import NotFoundError, Profile, Role, Store
 
 from interloper_api.dependencies.auth import get_current_user, get_org_id
 from interloper_api.dependencies.state import get_store

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/dependencies/state.py

@@ -10,7 +10,7 @@ from __future__ import annotations
 from typing import Annotated, Any
 
 from fastapi import Depends
-from interloper.catalog.base import Catalog
+from interloper.catalog import Catalog
 from interloper_db import Store
 
 _store: Store | None = None

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/routes/admin.py

@@ -541,7 +541,7 @@ def _runner_defaults(runner_type: str) -> dict[str, Any]:
         Allowlisted field names mapped to their default value, empty when the
         type is unregistered.
     """
-    from interloper.runner.base import RUNNERS
+    from interloper.runner import RUNNERS
 
     runner_cls = RUNNERS.get(runner_type)
     if runner_cls is None:

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/routes/auth.py

@@ -11,8 +11,7 @@ from zoneinfo import ZoneInfo
 import httpx2
 from fastapi import APIRouter, Cookie, HTTPException, Response
 from fastapi.responses import RedirectResponse
-from interloper.errors import NotFoundError
-from interloper_db import Organisation, Profile, Store
+from interloper_db import NotFoundError, Organisation, Profile, Store
 from interloper_db.models import AuthSession
 from pydantic import BaseModel, Field
 

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/routes/catalog.py

@@ -15,11 +15,10 @@ from typing import Any, Literal, NoReturn
 import httpx2
 import interloper as il
 from fastapi import APIRouter, Depends, HTTPException
-from interloper.connection.base import Connection
+from interloper.connection import Connection
 from interloper.errors import ConnectionCheckError, format_exception
-from interloper.resource.fields import is_fetch_field_provider
-from interloper.utils.concurrency import invoke
-from interloper.utils.imports import import_from_path
+from interloper.resource import is_fetch_field_provider
+from interloper.utils import import_from_path, invoke
 from pydantic import BaseModel, Field, ValidationError
 
 from interloper_api.dependencies import CatalogDep, EditorDep, require_viewer

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/routes/components.py

@@ -24,8 +24,8 @@ from uuid import UUID
 
 from fastapi import APIRouter, HTTPException, Query, Response
 from interloper.component import KINDS
-from interloper.errors import ComponentDriftError, DataNotFoundError
-from interloper_db import Component, ComponentQuery, ComponentStatus, DeleteImpact, Page, Store
+from interloper.errors import DataNotFoundError
+from interloper_db import Component, ComponentDriftError, ComponentQuery, ComponentStatus, DeleteImpact, Page, Store
 from pydantic import BaseModel
 
 from interloper_api.dependencies import (

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/routes/overview.py

@@ -14,7 +14,7 @@ from typing import Annotated, Literal
 from uuid import UUID
 
 from fastapi import APIRouter, HTTPException, Query
-from interloper.utils.time import assume_utc
+from interloper.utils import assume_utc
 from interloper_db import ComponentStatus
 from interloper_db.store import insights
 from pydantic import BaseModel

{interloper_api-0.112.0 → interloper_api-0.113.0}/src/interloper_api/routes/tokens.py

@@ -13,8 +13,7 @@ from typing import Annotated
 from uuid import UUID
 
 from fastapi import APIRouter, HTTPException, Query, Response
-from interloper.errors import NotFoundError
-from interloper_db import Page, PageQuery, Role, TokenQuery
+from interloper_db import NotFoundError, Page, PageQuery, Role, TokenQuery
 from pydantic import BaseModel, Field
 
 from interloper_api.dependencies import (

interloper_api-0.113.0/src/interloper_api/server.py

@@ -0,0 +1,72 @@
+"""The API as a supervised service: a uvicorn server over the FastAPI app."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import uvicorn
+from interloper.telemetry import instrument_fastapi
+
+from interloper_api.app import create_app
+
+if TYPE_CHECKING:
+    from fastapi import FastAPI
+    from interloper.catalog import Catalog
+    from interloper.settings import AppSettings
+    from interloper_db import Store
+
+
+class ApiServer:
+    """The HTTP API, served by uvicorn until stopped.
+
+    Attributes:
+        app: The FastAPI application; a composing process may add middleware to it before ``start``.
+    """
+
+    def __init__(self, app: FastAPI, server: uvicorn.Server) -> None:
+        """Hold the application and its server.
+
+        Args:
+            app: The FastAPI application.
+            server: The uvicorn server bound to it.
+        """
+        self.app = app
+        self._server = server
+
+    @classmethod
+    def from_settings(
+        cls,
+        settings: AppSettings,
+        *,
+        store: Store,
+        catalog: Catalog,
+        port: int,
+        cors_origins: list[str] | None = None,
+    ) -> ApiServer:
+        """Build the API and its server from settings.
+
+        Args:
+            settings: The active settings; ``server.host`` is the bind host.
+            store: The store the routes read and write through.
+            catalog: The catalog the routes describe.
+            port: The port to bind.
+            cors_origins: Origins allowed cross-origin requests; ``None`` allows none
+                (dev mode passes the Nuxt dev server's origin).
+
+        Returns:
+            The server, not yet started.
+        """
+        app = create_app(store=store, catalog=catalog, settings=settings, cors_origins=cors_origins)
+        instrument_fastapi(app)
+        config = uvicorn.Config(
+            app, host=settings.server.host, port=port, log_level="info", log_config=None, ws="wsproto"
+        )
+        return cls(app, uvicorn.Server(config))
+
+    def start(self) -> None:
+        """Serve until stopped."""
+        self._server.run()
+
+    def stop(self) -> None:
+        """Ask the server to finish its requests and return."""
+        self._server.should_exit = True