adressevaelger 0.1.0__tar.gz

adressevaelger-0.1.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.3
+Name: adressevaelger
+Version: 0.1.0
+Summary: Client library for accessing 'Adressevælger'
+Author: Erik Petersen
+Author-email: Erik Petersen <eht@it-trans.dk>
+Requires-Dist: dacite>=1.9.2
+Requires-Dist: pyproj>=3.7.2
+Requires-Dist: requests>=2.34.1
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# Adressevælger API Client
+
+
+## Introduction
+
+Client library for accessing "Adressevælger" Web API.
+
+- [API Documentation](https://confluence.sdfi.dk/pages/viewpage.action?pageId=234782998)
+- [API Base Address](https://adressevaelger.dk)
+
+
+## Example
+

adressevaelger-0.1.0/README.md

@@ -0,0 +1,13 @@
+# Adressevælger API Client
+
+
+## Introduction
+
+Client library for accessing "Adressevælger" Web API.
+
+- [API Documentation](https://confluence.sdfi.dk/pages/viewpage.action?pageId=234782998)
+- [API Base Address](https://adressevaelger.dk)
+
+
+## Example
+

adressevaelger-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "adressevaelger"
+version = "0.1.0"
+description = "Client library for accessing 'Adressevælger'"
+readme = "README.md"
+authors = [
+    { name = "Erik Petersen", email = "eht@it-trans.dk" }
+]
+requires-python = ">=3.13"
+dependencies = [
+    "dacite>=1.9.2",
+    "pyproj>=3.7.2",
+    "requests>=2.34.1",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.8,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "responses>=0.26.0",
+]

adressevaelger-0.1.0/src/adressevaelger/__init__.py

@@ -0,0 +1,5 @@
+from .client import Client
+from .exceptions import ApiConnectionError, ApiError
+from .models import Adressesoegning, Fund
+
+__all__ = ["Client", "Fund", "ApiError", "ApiConnectionError", "Adressesoegning"]

adressevaelger-0.1.0/src/adressevaelger/client.py

@@ -0,0 +1,90 @@
+import logging
+from dacite import Config
+from dataclasses import asdict
+from datetime import datetime, timezone
+from typing import List, Optional
+
+import requests
+from dacite import from_dict
+
+#from typing import TypeVar
+#virkningfra = TypeVar("virkningfra", str, datetime.datetime)
+#virkningtil = TypeVar("virkningtil", str, datetime.datetime)
+
+
+from .exceptions import ApiConnectionError, ApiError, ApiUnkownError
+from .models import Adresse, Adresseopslag, Adressesoegning, Fund, Husnummer, Husnummeropslag, Husnummersoegning, Soegeresultat
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+def parse_iso_z(value: str) -> datetime:
+    if value.endswith("Z"):
+        return datetime.fromisoformat(value[:-1]).replace(tzinfo=timezone.utc)
+    return datetime.fromisoformat(value)
+
+class Client:
+    def __init__(self, token: str = "adressevaelger123") -> None:
+        self.base_url = "https://adressevaelger.dk"
+        self.token = token
+
+    def _request(self, method: str, path: str, headers: dict = {}, params: dict = {}):
+        headers.update({"Accept": "application/json"})
+        params.update({"token": self.token})
+        try:
+            response = requests.request(
+                method=method,
+                url=self.base_url + f"/{path}",
+                headers=headers,
+                params=params,
+            )
+            logger.debug(f"Requ: {response.request.url}")
+            logger.debug(
+                f"Resp: Status code={response.status_code}, Payload={response.text}"
+            )
+            response.raise_for_status()
+            return response
+        except requests.ConnectionError as err:
+            logger.exception(err)
+            raise ApiConnectionError(err.strerror) from err
+        except requests.HTTPError as err:
+            logger.exception(err)
+            raise ApiError(response.text) from err
+
+    
+    def soeg_fonetisk(self, soegning: Adressesoegning | Husnummersoegning) -> List[Fund]:
+        params = asdict(soegning)
+        if isinstance(soegning, Adressesoegning):
+            response = self._request("GET", "adresser/soeg", params=params)
+        elif isinstance(soegning, Husnummersoegning):
+            response = self._request("GET", "husnumre/soeg", params=params)
+        else:
+            raise ValueError("Parameter must be of type Adressesoegning or HusnummerSoegning")
+        result = from_dict(data_class=Soegeresultat, data=response.json())
+        if result.status == "ok":
+            return result.fund
+        else:
+            raise ApiError(result.beskrivelse)
+
+
+    def husnummer_id(self, husnummer_id: str) -> Husnummer | None:
+        config = Config(type_hooks={datetime: parse_iso_z})
+
+        response = self._request("GET", f"husnumre/{husnummer_id}")
+        result = from_dict(data_class=Husnummeropslag, data=response.json(), config=config)
+        if result.status == "ok":
+            return result.husnummer
+        else:
+            return None
+
+    def adresse_id(self, adresse_id: str) -> Optional[Adresse]:
+        config = Config(type_hooks={datetime: parse_iso_z})
+
+        response = self._request("GET", f"adresser/{adresse_id}")
+        result = from_dict(data_class=Adresseopslag, data=response.json(), config=config)
+        if result.status == "ok":
+            return result.adresse
+        else:
+            return None
+
+

adressevaelger-0.1.0/src/adressevaelger/exceptions.py

@@ -0,0 +1,12 @@
+
+class ApiError(Exception):
+    
+    def __init__(self, message: str | None):
+        self.message = message
+        super().__init__(self.message)
+
+class ApiConnectionError(ApiError):
+    pass
+
+class ApiUnkownError(ApiError):
+    pass

adressevaelger-0.1.0/src/adressevaelger/models.py

@@ -0,0 +1,186 @@
+import datetime
+from dataclasses import dataclass, asdict
+from typing import List, Optional
+
+
+@dataclass
+class Adressesoegning:
+    tekst: Optional[str] = None
+    vejnavn: Optional[str] = None
+    husnummer: Optional[str] = None
+    postnummer: Optional[str] = None
+    kommunekode: Optional[str] = None
+    medtagforeloebige: Optional[str] = None
+    etage: Optional[str] = None
+    doer: Optional[str] = None
+    maksimum: Optional[int] = None
+
+
+@dataclass
+class Husnummersoegning:
+    tekst: Optional[str] = None
+    vejnavn: Optional[str] = None
+    husnummer: Optional[str] = None
+    postnummer: Optional[str] = None
+    kommunekode: Optional[str] = None
+    medtagforeloebige: Optional[str] = None
+    maksimum: Optional[int] = None
+
+
+@dataclass
+class Fund:
+    type: str
+    id: Optional[str] = None
+    titel: Optional[str] = None
+    vejnavn: Optional[str] = None
+    husnummer: Optional[str] = None
+    postnr: Optional[str] = None
+    postdistrikt: Optional[str] = None
+    antal_husnumre: Optional[int] = None
+    husnummerId: Optional[str] = None
+
+    def asdict(self):
+        return asdict(self)
+
+
+@dataclass
+class Soegeresultat:
+    status: str
+    beskrivelse: str
+    fund: List[Fund]
+
+
+@dataclass
+class Koordinater:
+    x: Optional[float]
+    y: Optional[float]
+
+
+@dataclass
+class CRSProperties:
+    name: Optional[str]
+
+
+@dataclass
+class CRS:
+    type: Optional[str]
+    properties: Optional[CRSProperties]
+
+
+@dataclass
+class Geometri:
+    type: Optional[str]
+    crs: Optional[CRS]
+    coordinates: Optional[List[float]]
+
+
+@dataclass
+class Adgangspunkt:
+    id_lokalid: Optional[str]
+    status: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+    geometri: Optional[Geometri]
+    koordinater: Optional[Koordinater]
+
+
+@dataclass
+class Postnummer:
+    id_lokalid: Optional[str]
+    navn: Optional[str]
+    postnr: Optional[str]
+    status: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+
+
+@dataclass()
+class NavngivenVej:
+    id_lokalid: Optional[str]
+    vejnavn: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+
+
+@dataclass()
+class NavngivenVejKommunedel:
+    id_lokalid: Optional[str]
+    kommune: Optional[str]
+    vejkode: Optional[str]
+    navngivenvej: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+
+
+@dataclass()
+class NavngivenVejPostnummer:
+    id_lokalid: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+
+
+@dataclass()
+class SupplerendeBynavn:
+    id_lokalid: Optional[str]
+    status: Optional[str]
+    supplerendebynavn: Optional[str]
+    navn: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+
+
+@dataclass
+class Husnummer:
+    id_lokalid: str
+    husnummertekst: Optional[str]
+    adgangsadressebetegnelse: Optional[str]
+    vejnavn: Optional[str]
+    status: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+    adgangspunkt: Optional[Adgangspunkt]
+    postnummer: Optional[Postnummer]
+    navngivenvej: Optional[NavngivenVej]
+    navngivenvejkommunedel: Optional[NavngivenVejKommunedel]
+    navngivenvejpostnummer: Optional[NavngivenVejPostnummer]
+    supplerendebynavn: Optional[SupplerendeBynavn]
+
+
+@dataclass
+class Husnummeropslag:
+    status: str
+    husnummer: Husnummer
+
+
+@dataclass
+class Adresse:
+    id_lokalid: str
+    adressebetegnelse: Optional[str]
+    etagebetegnelse: Optional[str]
+    doerbetegnelse: Optional[str]
+    status: Optional[str]
+    virkningfra: Optional[datetime.datetime]
+    virkningtil: Optional[datetime.datetime]
+    registreringfra: Optional[datetime.datetime]
+    registreringtil: Optional[datetime.datetime]
+    husnummer: Optional[Husnummer]
+
+
+@dataclass
+class Adresseopslag:
+    status: Optional[str]
+    adresse: Optional[Adresse]