lodapi 0.0.1__tar.gz → 0.0.2__tar.gz

lodapi-0.0.2/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.0.2 — 2026-06-14
+
+### Fixed
+- **`buildings()` crashte bei jedem Call** durch Schema-Drift: das Modell
+  `BuildingsBboxAttribution` verlangte ein Pflichtfeld `bundesland`, die Live-API
+  liefert aber `bundesland_code` (+ `license_id`, `attribution_url`, `license_url`,
+  `requires_attribution`). Modell an die **echte** Live-Form angepasst
+  (verifiziert gegen api.lodapi.de). Ursache: der committete OpenAPI-Snapshot,
+  aus dem die v0-Modelle abgeleitet wurden, war gegenüber dem Prod-Deploy stale.
+
+### Changed
+- Response-Modelle der buildings-Endpoints (`BuildingsBboxAttribution`,
+  `BuildingDetail`) auf **durchgängig Optional** umgestellt. Ein Client-SDK gegen
+  eine junge API darf nicht an einem umbenannten/fehlenden Feld crashen
+  (`extra="allow"` fängt *neue* Felder, Optional fängt *entfernte/umbenannte*).
+- Neuer opt-in **Live-Smoke-Test** (`pytest -m live`) gegen api.lodapi.de, der
+  genau diese Art Drift künftig fängt — die gemockten Unit-Tests prüften das
+  Fixture, nicht die reale API.
+
+## 0.0.1 — 2026-06-14
+
+- Erstes Release: ergonomische Facade über der Lodapi-REST-API
+  (buildings/terrain/tilesets/datasets), `X-API-Key`-Auth, Free-Tier,
+  optionales `[geo]`-Extra, RFC-7807-Fehler, Soft-Quota-Header.

{lodapi-0.0.1 → lodapi-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lodapi
-Version: 0.0.1
+Version: 0.0.2
 Summary: Ergonomic Python SDK for the Lodapi REST API (LoD2 buildings, terrain, 3D tiles).
 Project-URL: Homepage, https://lodapi.de
 Project-URL: Documentation, https://lodapi.de/docs

{lodapi-0.0.1 → lodapi-0.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "lodapi"
-version = "0.0.1"
+version = "0.0.2"
 description = "Ergonomic Python SDK for the Lodapi REST API (LoD2 buildings, terrain, 3D tiles)."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -46,3 +46,9 @@ packages = ["src/lodapi"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+# Live-Tests (echte api.lodapi.de) standardmäßig ausgeschlossen — CI/offline
+# läuft rein gegen respx-Mocks. Explizit anfordern via: pytest -m live
+addopts = "-m 'not live'"
+markers = [
+    "live: hits the real api.lodapi.de (network); run with `pytest -m live`",
+]

{lodapi-0.0.1 → lodapi-0.0.2}/src/lodapi/client.py

@@ -33,7 +33,7 @@ from .resources.tilesets import TilesetsResource
 try:
     __version__ = version("lodapi")
 except PackageNotFoundError:  # pragma: no cover - editable/uninstalled
-    __version__ = "0.0.1"
+    __version__ = "0.0.2"
 
 
 class Client:

{lodapi-0.0.1 → lodapi-0.0.2}/src/lodapi/models.py

@@ -47,9 +47,22 @@ class _Model(BaseModel):
 # --------------------------------------------------------------------------
 
 class BuildingsBboxAttribution(_Model):
-    bundesland: str
-    license: Optional[str] = None
+    """Per-Bundesland attribution/licence block in ``lodapi.attribution[]``.
+
+    Shape verified against the live API (api.lodapi.de, 2026-06-14). All fields
+    are Optional on purpose: this is a young, evolving API and a client SDK must
+    never crash on a renamed/missing attribution field (``extra="allow"`` covers
+    *added* fields; Optional covers *removed/renamed* ones). The committed
+    OpenAPI snapshot lagged here (had ``bundesland``/``license``) — see SDK
+    CHANGELOG 0.0.2.
+    """
+
+    bundesland_code: Optional[str] = None
+    license_id: Optional[str] = None
     attribution_text: Optional[str] = None
+    attribution_url: Optional[str] = None
+    license_url: Optional[str] = None
+    requires_attribution: Optional[bool] = None
 
 
 class BuildingsBboxLodapiMeta(_Model):
@@ -90,9 +103,11 @@ class BuildingsBboxResponse(_Model):
 # --------------------------------------------------------------------------
 
 class BuildingDetail(_Model):
-    gmlid: str
-    bundesland_code: str
-    building_id: int
+    # All Optional by design — a client SDK must not crash if the API renames
+    # or drops a field (extra="allow" covers added fields). See 0.0.2 fix.
+    gmlid: Optional[str] = None
+    bundesland_code: Optional[str] = None
+    building_id: Optional[int] = None
     geometry: Optional[dict[str, Any]] = None
     lod: str = "LoD2"
 

{lodapi-0.0.1 → lodapi-0.0.2}/tests/conftest.py

@@ -44,8 +44,18 @@ def buildings_page(next_cursor=None, ids=("A", "B")):
         ],
         "lodapi": {
             "next": next_cursor,
+            # Real live-API shape (verified api.lodapi.de 2026-06-14): the
+            # attribution block uses bundesland_code/license_id + url/flag fields,
+            # NOT the stale bundesland/license the snapshot once had.
             "attribution": [
-                {"bundesland": "bw", "license": "dl-de-zero-2.0", "attribution_text": "© LGL-BW"}
+                {
+                    "bundesland_code": "bw",
+                    "license_id": "dl-de-zero-2.0",
+                    "attribution_text": "© LGL-BW",
+                    "attribution_url": "https://www.lgl-bw.de/",
+                    "license_url": "https://www.govdata.de/dl-de/zero-2-0",
+                    "requires_attribution": False,
+                }
             ],
         },
     }

{lodapi-0.0.1 → lodapi-0.0.2}/tests/test_buildings.py

@@ -37,7 +37,10 @@ def test_buildings_single_page(client):
 
     assert page.count == 2
     assert len(page.features) == 2
-    assert page.lodapi.attribution[0].bundesland == "bw"
+    att = page.lodapi.attribution[0]
+    assert att.bundesland_code == "bw"
+    assert att.license_id == "dl-de-zero-2.0"
+    assert att.requires_attribution is False
     # bbox tuple serialized into the query, limit forwarded, no `bl` param
     req = route.calls.last.request
     assert req.url.params["bbox"] == "7.0,50.9,7.1,51.0"

lodapi-0.0.2/tests/test_live_smoke.py

@@ -0,0 +1,47 @@
+"""Opt-in live smoke tests against the real api.lodapi.de.
+
+These are EXCLUDED from the default run (`addopts = -m 'not live'` in
+pyproject) because CI runs offline against respx mocks. Run explicitly with::
+
+    uv run --extra dev pytest -m live
+
+Why these exist: the 0.0.2 buildings() crash slipped through because the
+mocked unit tests validated the *fixture*, not the live API. A real call
+parsing through the Pydantic models is the only thing that catches schema
+drift between the SDK and the deployed API.
+"""
+
+from __future__ import annotations
+
+import pytest
+
+from lodapi import Client
+from lodapi.models import BuildingsBboxResponse
+
+# Small bbox over Cologne (NRW) — stable, non-empty, free-tier (no key needed).
+_BBOX = (7.00, 50.94, 7.02, 50.95)
+
+
+@pytest.mark.live
+def test_buildings_bbox_parses_against_live_api() -> None:
+    """buildings() must parse a real federated response without raising."""
+    with Client() as c:
+        page = c.buildings(bbox=_BBOX, limit=1)
+
+    assert isinstance(page, BuildingsBboxResponse)
+    assert page.type == "FeatureCollection"
+    assert isinstance(page.count, int)
+    # The attribution block is the field that drifted in 0.0.2 — assert it
+    # parses and carries the real live shape.
+    if page.lodapi.attribution:
+        att = page.lodapi.attribution[0]
+        assert att.bundesland_code is not None
+        # license/url/flag are tolerated as Optional, just must not raise.
+
+
+@pytest.mark.live
+def test_datasets_parses_against_live_api() -> None:
+    with Client() as c:
+        ds = c.datasets()
+    assert ds.datasets, "expected at least one live dataset"
+    assert ds.datasets[0].bundesland_code