etlantic-fastapi 0.24.0__tar.gz

etlantic_fastapi-0.24.0/.gitignore

@@ -0,0 +1,32 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+dist/
+build/
+site/
+.venv/
+venv/
+.env
+
+# Tools
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+# macOS
+.DS_Store
+**/.DS_Store
+._*
+**/._*
+
+examples/_file_storage_out/
+examples/_generated_*.py
+tmp_cli_contracts/
+tmp_/
+
+# Local durable workspace (reports, artifacts, schema history)
+.etlantic/

etlantic_fastapi-0.24.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: etlantic-fastapi
+Version: 0.24.0
+Summary: Thin FastAPI reference adapter for ETLantic 0.24 authoring/service contracts.
+Project-URL: Homepage, https://github.com/eddiethedean/etlantic
+Project-URL: Documentation, https://etlantic.readthedocs.io/
+Project-URL: Repository, https://github.com/eddiethedean/etlantic
+Project-URL: Issues, https://github.com/eddiethedean/etlantic/issues
+Author-email: Odo Matthews <odosmatthews@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: etlantic<0.25,>=0.24.0
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: pydantic<3,>=2.12
+Provides-Extra: test
+Requires-Dist: httpx<1,>=0.27; extra == 'test'
+Description-Content-Type: text/markdown
+
+# etlantic-fastapi
+
+Thin FastAPI reference adapter for the ETLantic 0.24 authoring and service
+contract. Not a production control plane (see 1.1 FastAPI Integration Plan).
+
+```bash
+pip install etlantic-fastapi
+```
+
+```python
+from etlantic_fastapi import create_reference_app
+
+app = create_reference_app()
+```

etlantic_fastapi-0.24.0/README.md

@@ -0,0 +1,14 @@
+# etlantic-fastapi
+
+Thin FastAPI reference adapter for the ETLantic 0.24 authoring and service
+contract. Not a production control plane (see 1.1 FastAPI Integration Plan).
+
+```bash
+pip install etlantic-fastapi
+```
+
+```python
+from etlantic_fastapi import create_reference_app
+
+app = create_reference_app()
+```

etlantic_fastapi-0.24.0/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "etlantic-fastapi"
+version = "0.24.0"
+description = "Thin FastAPI reference adapter for ETLantic 0.24 authoring/service contracts."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [{ name = "Odo Matthews", email = "odosmatthews@gmail.com" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "etlantic>=0.24.0,<0.25",
+    "fastapi>=0.115,<1",
+    "pydantic>=2.12,<3",
+]
+
+[project.optional-dependencies]
+test = ["httpx>=0.27,<1"]
+
+[dependency-groups]
+dev = [
+    "httpx>=0.27,<1",
+    "pytest>=8,<9",
+]
+
+[project.urls]
+Homepage = "https://github.com/eddiethedean/etlantic"
+Documentation = "https://etlantic.readthedocs.io/"
+Repository = "https://github.com/eddiethedean/etlantic"
+Issues = "https://github.com/eddiethedean/etlantic/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/etlantic_fastapi"]

etlantic_fastapi-0.24.0/src/etlantic_fastapi/__init__.py

@@ -0,0 +1,116 @@
+"""Thin FastAPI reference adapter for ETLantic authoring/service contracts."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+from etlantic.service import AuthoringService, PolicyContext
+from fastapi import FastAPI, HTTPException
+
+__version__ = "0.24.0"
+
+
+class DefinitionDocument(BaseModel):
+    document: dict[str, Any]
+    idempotency_key: str | None = None
+
+
+class EditRequest(BaseModel):
+    command: dict[str, Any]
+    expected_token: str | None = None
+
+
+class RunSubmitRequest(BaseModel):
+    idempotency_key: str | None = None
+
+
+def create_reference_app(
+    *,
+    service: AuthoringService | None = None,
+    title: str = "ETLantic Authoring Reference",
+    version: str = "0.24.0",
+) -> FastAPI:
+    """Create a FastAPI app exposing the public authoring/service facade."""
+    svc = service or AuthoringService(policy=PolicyContext())
+    app = FastAPI(title=title, version=version)
+    app.state.service = svc
+
+    @app.get("/negotiation")
+    def negotiation() -> dict[str, Any]:
+        return svc.negotiation()
+
+    @app.get("/catalog")
+    def catalog(definition_id: str | None = None) -> dict[str, Any]:
+        return svc.catalog(definition_id)
+
+    @app.put("/pipelines/{definition_id}")
+    def put_pipeline(definition_id: str, body: DefinitionDocument) -> dict[str, Any]:
+        try:
+            return svc.put_definition(
+                definition_id,
+                body.document,
+                idempotency_key=body.idempotency_key,
+            )
+        except Exception as exc:
+            raise HTTPException(status_code=400, detail=str(exc)) from exc
+
+    @app.get("/pipelines/{definition_id}")
+    def get_pipeline(definition_id: str) -> dict[str, Any]:
+        try:
+            return svc.get_definition(definition_id)
+        except KeyError as exc:
+            raise HTTPException(status_code=404, detail="definition not found") from exc
+
+    @app.post("/pipelines/{definition_id}/edits")
+    def edit_pipeline(definition_id: str, body: EditRequest) -> dict[str, Any]:
+        try:
+            return svc.apply_edit(
+                definition_id, body.command, expected_token=body.expected_token
+            )
+        except Exception as exc:
+            raise HTTPException(status_code=400, detail=str(exc)) from exc
+
+    @app.post("/pipelines/{definition_id}/validate")
+    def validate_pipeline(definition_id: str) -> dict[str, Any]:
+        try:
+            return svc.validate(definition_id)
+        except KeyError as exc:
+            raise HTTPException(status_code=404, detail="definition not found") from exc
+
+    @app.post("/pipelines/{definition_id}/plan")
+    def plan_pipeline(definition_id: str) -> dict[str, Any]:
+        try:
+            return svc.plan(definition_id)
+        except KeyError as exc:
+            raise HTTPException(status_code=404, detail="definition not found") from exc
+
+    @app.post("/pipelines/{definition_id}/runs")
+    def submit_run(
+        definition_id: str, body: RunSubmitRequest | None = None
+    ) -> dict[str, Any]:
+        body = body or RunSubmitRequest()
+        try:
+            return svc.submit_run(definition_id, idempotency_key=body.idempotency_key)
+        except KeyError as exc:
+            raise HTTPException(status_code=404, detail="definition not found") from exc
+
+    @app.get("/runs/{job_id}")
+    def run_status(job_id: str) -> dict[str, Any]:
+        try:
+            return svc.job_status(job_id)
+        except KeyError as exc:
+            raise HTTPException(status_code=404, detail="job not found") from exc
+
+    @app.post("/runs/{job_id}/cancel")
+    def cancel_run(job_id: str) -> dict[str, Any]:
+        try:
+            return svc.cancel_run(job_id)
+        except KeyError as exc:
+            raise HTTPException(status_code=404, detail="job not found") from exc
+
+    return app
+
+
+__all__ = ["AuthoringService", "PolicyContext", "create_reference_app"]

etlantic_fastapi-0.24.0/tests/test_fastapi_reference_package.py

@@ -0,0 +1,41 @@
+"""FastAPI reference adapter OpenAPI + service fixture (no examples import)."""
+
+from __future__ import annotations
+
+import pytest
+
+from etlantic.authoring import (
+    definition_from_pipeline,
+    pipeline_to_dict,
+)
+from etlantic.authoring.resolve import callable_registry
+
+fastapi = pytest.importorskip("fastapi")
+etlantic_fastapi = pytest.importorskip("etlantic_fastapi")
+from examples.memory_customers import (  # noqa: E402
+    CustomerPipeline,
+    normalize_customers,
+)
+
+from etlantic_fastapi import create_reference_app  # noqa: E402
+
+
+def test_openapi_and_service_fixture() -> None:
+    defn = definition_from_pipeline(CustomerPipeline)
+    callable_registry().register(
+        defn.transformations[0].identity, "local", normalize_customers
+    )
+    app = create_reference_app()
+    schema = app.openapi()
+    assert "/catalog" in schema["paths"]
+    assert "/pipelines/{definition_id}" in schema["paths"]
+    assert "/negotiation" in schema["paths"]
+
+    svc = app.state.service
+    assert "document_versions" in svc.negotiation()
+    assert svc.negotiation().get("run_model") == "synchronous_reference"
+    put = svc.put_definition("demo", pipeline_to_dict(defn))
+    assert put["fingerprint"]
+    assert "entries" in svc.catalog("demo")
+    assert "diagnostics" in svc.validate("demo")
+    assert "plan" in svc.plan("demo")