lhpapi 1.0.3__tar.gz → 1.0.4__tar.gz

{lhpapi-1.0.3 → lhpapi-1.0.4}/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.4 (2024-12-24)
+### Fixed
+- Fix NI invalid values
+- Fix BB encoding
+- Add get_all_stations()
+
 ## 1.0.3 (2024-10-02)
 ### Fixed
 - Fix BE encoding

{lhpapi-1.0.3 → lhpapi-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: lhpapi
-Version: 1.0.3
+Version: 1.0.4
 Summary: API to retrieve data from the Länderübergreifendes Hochwasser Portal (LHP)
 Project-URL: Homepage, https://github.com/stephan192/lhpapi
 Project-URL: Issues, https://github.com/stephan192/lhpapi/issues

{lhpapi-1.0.3 → lhpapi-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "lhpapi"
-version = "1.0.3"
+version = "1.0.4"
 authors = [
     { name="stephan192", email="stephan192@outlook.com" },
 ]

{lhpapi-1.0.3 → lhpapi-1.0.4}/src/lhpapi/__init__.py

@@ -6,7 +6,7 @@ from datetime import datetime
 from types import FunctionType
 from typing import Final
 
-from .api_utils import DynamicData, LHPError, StaticData
+from .api_utils import DynamicData, LHPError, StaticData, fetch_json
 from .bb_api import init_BB, update_BB
 from .be_api import init_BE, update_BE
 from .bw_api import init_BW, update_BW
@@ -70,6 +70,13 @@ def update_lhp_data(static_data: StaticData) -> DynamicData:
     )
 
 
+def get_all_stations() -> dict[str, str]:
+    """Return all available stations."""
+    return fetch_json(
+        "https://raw.githubusercontent.com/stephan192/lhpapi/refs/heads/master/docs/pegel.json"
+    )
+
+
 class HochwasserPortalAPI:
     """API to retrieve the data."""
 

{lhpapi-1.0.3 → lhpapi-1.0.4}/src/lhpapi/bb_api.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from html import unescape
+
 from .api_utils import (
     DynamicData,
     LHPError,
@@ -61,7 +63,7 @@ def fix_bb_encoding(string_in: str) -> str:
                     replace = False
         else:
             string_out = string_out + chr(num)
-    return string_out
+    return unescape(string_out)
 
 
 def init_BB(ident: str) -> StaticData:  # pylint: disable=invalid-name

{lhpapi-1.0.3 → lhpapi-1.0.4}/src/lhpapi/ni_api.py

@@ -72,6 +72,8 @@ def update_NI(static_data: StaticData) -> DynamicData:  # pylint: disable=invali
             )
         except (IndexError, KeyError):
             value = None
+        if value == -888.0:
+            value = None
         try:
             if data["getStammdatenResult"][0]["Parameter"][0]["Einheit"] == "cm":
                 level = value
@@ -85,15 +87,18 @@ def update_NI(static_data: StaticData) -> DynamicData:  # pylint: disable=invali
         except (IndexError, KeyError):
             level = None
             flow = None
-        try:
-            last_update = convert_to_datetime(
-                data["getStammdatenResult"][0]["Parameter"][0]["Datenspuren"][0][
-                    "AktuellerMesswert_Zeitpunkt"
-                ],
-                "%d.%m.%Y %H:%M",
-            )
-        except (IndexError, KeyError):
+        if (level is None) and (flow is None):
             last_update = None
+        else:
+            try:
+                last_update = convert_to_datetime(
+                    data["getStammdatenResult"][0]["Parameter"][0]["Datenspuren"][0][
+                        "AktuellerMesswert_Zeitpunkt"
+                    ],
+                    "%d.%m.%Y %H:%M",
+                )
+            except (IndexError, KeyError):
+                last_update = None
         return DynamicData(level=level, stage=stage, flow=flow, last_update=last_update)
     except Exception as err:
         raise LHPError(err, "ni_api.py: update_NI()") from err