motorbay-client 0.1.0__tar.gz

motorbay_client-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+.venv/
+__pycache__/
+bin/
+obj/
+.pytest_cache/

motorbay_client-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: motorbay-client
+Version: 0.1.0
+Summary: Python client for the Motorbay API: Danish vehicle data from Motorstyrelsen's public weekly extract. Generated from the OpenAPI document.
+Project-URL: Homepage, https://motorbay.app
+Project-URL: Documentation, https://app.motorbay.app/en/docs
+License-Expression: MIT
+Keywords: api,client,denmark,dmr,motorbay,motorregister,vehicle
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29.0,>=0.23.0
+Requires-Dist: python-dateutil>=2.8.0
+Description-Content-Type: text/markdown
+
+# motorbay-client
+
+Python client for the Motorbay API (Danish vehicle data from Motorstyrelsen's
+public weekly extract). `motorbay` is the small wrapper you import.
+`motorbay_client` holds the models, generated by openapi-python-client from the
+API's OpenAPI document. Python 3.10+.
+
+```sh
+pip install motorbay-client
+```
+
+```python
+from motorbay import MotorbayApiError, MotorbayClient
+
+with MotorbayClient(api_key="mbk_live_...") as motorbay:
+    try:
+        vehicle = motorbay.lookup_vehicle("AB12345", include=["engine", "inspection"])
+        print(vehicle.make.name, vehicle.registration_number)
+    except MotorbayApiError as e:
+        if e.code == "VehicleNotFound":
+            print("No such vehicle")
+        elif e.status == 429:
+            print(f"Retry in {e.retry_after}s")
+        else:
+            raise
+```
+
+Setup and tests (offline, httpx.MockTransport):
+
+```sh
+uv venv .venv && uv pip install -p .venv -r requirements-dev.txt
+.venv/bin/python -m pytest -q
+```

motorbay_client-0.1.0/README.md

@@ -0,0 +1,33 @@
+# motorbay-client
+
+Python client for the Motorbay API (Danish vehicle data from Motorstyrelsen's
+public weekly extract). `motorbay` is the small wrapper you import.
+`motorbay_client` holds the models, generated by openapi-python-client from the
+API's OpenAPI document. Python 3.10+.
+
+```sh
+pip install motorbay-client
+```
+
+```python
+from motorbay import MotorbayApiError, MotorbayClient
+
+with MotorbayClient(api_key="mbk_live_...") as motorbay:
+    try:
+        vehicle = motorbay.lookup_vehicle("AB12345", include=["engine", "inspection"])
+        print(vehicle.make.name, vehicle.registration_number)
+    except MotorbayApiError as e:
+        if e.code == "VehicleNotFound":
+            print("No such vehicle")
+        elif e.status == 429:
+            print(f"Retry in {e.retry_after}s")
+        else:
+            raise
+```
+
+Setup and tests (offline, httpx.MockTransport):
+
+```sh
+uv venv .venv && uv pip install -p .venv -r requirements-dev.txt
+.venv/bin/python -m pytest -q
+```

motorbay_client-0.1.0/motorbay/__init__.py

@@ -0,0 +1,118 @@
+"""Thin, hand-written wrapper over the generated ``motorbay_client`` package.
+
+``motorbay_client`` is generated by openapi-python-client from ../openapi/v1.json
+(scripts/generate-all.sh). This module is not generated.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import Any
+
+import httpx
+
+from motorbay_client.api.vehicles import (
+    get_vehicle_by_plate,
+    get_vehicle_by_plate_or_vin,
+    get_vehicle_by_vin,
+)
+from motorbay_client.models.vehicle_response import VehicleResponse
+
+__all__ = ["DEFAULT_BASE_URL", "MotorbayApiError", "MotorbayClient", "VehicleResponse"]
+
+DEFAULT_BASE_URL = "https://api.motorbay.app"
+
+
+class MotorbayApiError(Exception):
+    """A problem+json error answer from the API."""
+
+    def __init__(
+        self,
+        status: int,
+        code: str | None = None,
+        title: str | None = None,
+        detail: str | None = None,
+        request_id: str | None = None,
+        retry_after: int | None = None,
+        body: Any = None,
+    ) -> None:
+        super().__init__(detail or title or f"Motorbay API answered {status}")
+        self.status = status
+        self.code = code
+        self.title = title
+        self.detail = detail
+        self.request_id = request_id
+        #: Seconds from the Retry-After header, set on 429 and 503.
+        self.retry_after = retry_after
+        self.body = body
+
+
+class MotorbayClient:
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = DEFAULT_BASE_URL,
+        *,
+        timeout: float = 30.0,
+        transport: httpx.BaseTransport | None = None,
+    ) -> None:
+        if not api_key:
+            raise ValueError("api_key is required")
+        self._http = httpx.Client(
+            base_url=base_url.rstrip("/"),
+            headers={"X-Api-Key": api_key, "Accept": "application/json, application/problem+json"},
+            timeout=timeout,
+            transport=transport,
+        )
+
+    def close(self) -> None:
+        self._http.close()
+
+    def __enter__(self) -> MotorbayClient:
+        return self
+
+    def __exit__(self, *exc: object) -> None:
+        self.close()
+
+    def lookup_vehicle(self, plate_or_vin: str, include: Iterable[str] | None = None) -> VehicleResponse:
+        """GET /v1/vehicles/lookup/{plateOrVin}: a plate or a VIN, with optional include parts."""
+        return self._vehicle(get_vehicle_by_plate_or_vin._get_kwargs(plate_or_vin), include)
+
+    def get_vehicle_by_plate(self, plate: str, include: Iterable[str] | None = None) -> VehicleResponse:
+        return self._vehicle(get_vehicle_by_plate._get_kwargs(plate), include)
+
+    def get_vehicle_by_vin(self, vin: str, include: Iterable[str] | None = None) -> VehicleResponse:
+        return self._vehicle(get_vehicle_by_vin._get_kwargs(vin), include)
+
+    def _vehicle(self, kwargs: dict[str, Any], include: Iterable[str] | None) -> VehicleResponse:
+        params = dict(kwargs.get("params") or {})
+        parts = [getattr(p, "value", p) for p in include or ()]
+        if parts:
+            params["include"] = ",".join(parts)
+        response = self._http.request(kwargs["method"], kwargs["url"], params=params)
+        if response.is_success:
+            return VehicleResponse.from_dict(response.json())
+        raise _to_error(response)
+
+
+def _to_error(response: httpx.Response) -> MotorbayApiError:
+    try:
+        body = response.json()
+    except ValueError:
+        body = None
+    data = body if isinstance(body, dict) else {}
+
+    def text(key: str) -> str | None:
+        value = data.get(key)
+        return value if isinstance(value, str) else None
+
+    retry_header = (response.headers.get("Retry-After") or "").strip()
+    return MotorbayApiError(
+        status=response.status_code,
+        code=text("code"),
+        title=text("title"),
+        detail=text("detail"),
+        request_id=text("requestId") or response.headers.get("X-Request-Id"),
+        retry_after=int(retry_header) if retry_header.isdigit() else None,
+        body=body,
+    )

motorbay_client-0.1.0/motorbay_client/__init__.py

@@ -0,0 +1,8 @@
+
+""" A client library for accessing Motorbay API """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

motorbay_client-0.1.0/motorbay_client/api/__init__.py

@@ -0,0 +1 @@
+""" Contains methods for accessing the API """

motorbay_client-0.1.0/motorbay_client/api/account/__init__.py

@@ -0,0 +1 @@
+""" Contains endpoint functions for accessing the API """

motorbay_client-0.1.0/motorbay_client/api/account/get_account_usage.py

@@ -0,0 +1,210 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.account_usage_response import AccountUsageResponse
+from ...models.problem_details import ProblemDetails
+from typing import cast
+
+
+
+def _get_kwargs(
+    
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/usage",
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> AccountUsageResponse | ProblemDetails | None:
+    if response.status_code == 200:
+        response_200 = AccountUsageResponse.from_dict(response.json())
+
+
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_401
+
+    if response.status_code == 402:
+        response_402 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_402
+
+    if response.status_code == 429:
+        response_429 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_429
+
+    if response.status_code == 500:
+        response_500 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[AccountUsageResponse | ProblemDetails]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[AccountUsageResponse | ProblemDetails]:
+    """ Get this month's usage
+
+     Returns the account's usage this calendar month (UTC): requests counted, the plan's included
+    requests, the hard limit and what remains of it (null on paid plans, which have none), and the
+    requests counted with the API key that asks. Only answered (2xx) requests count toward the plan, and
+    a batch counts the plates it found. This call is free: it does not count toward the plan. It counts
+    toward the per-minute rate limit like every request.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AccountUsageResponse | ProblemDetails]
+     """
+
+
+    kwargs = _get_kwargs(
+        
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> AccountUsageResponse | ProblemDetails | None:
+    """ Get this month's usage
+
+     Returns the account's usage this calendar month (UTC): requests counted, the plan's included
+    requests, the hard limit and what remains of it (null on paid plans, which have none), and the
+    requests counted with the API key that asks. Only answered (2xx) requests count toward the plan, and
+    a batch counts the plates it found. This call is free: it does not count toward the plan. It counts
+    toward the per-minute rate limit like every request.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AccountUsageResponse | ProblemDetails
+     """
+
+
+    return sync_detailed(
+        client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[AccountUsageResponse | ProblemDetails]:
+    """ Get this month's usage
+
+     Returns the account's usage this calendar month (UTC): requests counted, the plan's included
+    requests, the hard limit and what remains of it (null on paid plans, which have none), and the
+    requests counted with the API key that asks. Only answered (2xx) requests count toward the plan, and
+    a batch counts the plates it found. This call is free: it does not count toward the plan. It counts
+    toward the per-minute rate limit like every request.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AccountUsageResponse | ProblemDetails]
+     """
+
+
+    kwargs = _get_kwargs(
+        
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> AccountUsageResponse | ProblemDetails | None:
+    """ Get this month's usage
+
+     Returns the account's usage this calendar month (UTC): requests counted, the plan's included
+    requests, the hard limit and what remains of it (null on paid plans, which have none), and the
+    requests counted with the API key that asks. Only answered (2xx) requests count toward the plan, and
+    a batch counts the plates it found. This call is free: it does not count toward the plan. It counts
+    toward the per-minute rate limit like every request.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AccountUsageResponse | ProblemDetails
+     """
+
+
+    return (await asyncio_detailed(
+        client=client,
+
+    )).parsed

motorbay_client-0.1.0/motorbay_client/api/blocking_reasons/__init__.py

@@ -0,0 +1 @@
+""" Contains endpoint functions for accessing the API """

motorbay_client-0.1.0/motorbay_client/api/blocking_reasons/get_blocking_reason.py

@@ -0,0 +1,222 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.blocking_reason_response import BlockingReasonResponse
+from ...models.problem_details import ProblemDetails
+from typing import cast
+
+
+
+def _get_kwargs(
+    id: int | str,
+
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/blocking-reasons/{id}".format(id=quote(str(id), safe=""),),
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> BlockingReasonResponse | ProblemDetails | None:
+    if response.status_code == 200:
+        response_200 = BlockingReasonResponse.from_dict(response.json())
+
+
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_401
+
+    if response.status_code == 402:
+        response_402 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_402
+
+    if response.status_code == 404:
+        response_404 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_429
+
+    if response.status_code == 500:
+        response_500 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = ProblemDetails.from_dict(response.json())
+
+
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[BlockingReasonResponse | ProblemDetails]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int | str,
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[BlockingReasonResponse | ProblemDetails]:
+    """ Get a blocking reason
+
+     Retrieves a specific blocking reason by ID, such as Totalskadet køretøj or Mangel.
+
+    Args:
+        id (int | str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[BlockingReasonResponse | ProblemDetails]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    id: int | str,
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> BlockingReasonResponse | ProblemDetails | None:
+    """ Get a blocking reason
+
+     Retrieves a specific blocking reason by ID, such as Totalskadet køretøj or Mangel.
+
+    Args:
+        id (int | str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        BlockingReasonResponse | ProblemDetails
+     """
+
+
+    return sync_detailed(
+        id=id,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    id: int | str,
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[BlockingReasonResponse | ProblemDetails]:
+    """ Get a blocking reason
+
+     Retrieves a specific blocking reason by ID, such as Totalskadet køretøj or Mangel.
+
+    Args:
+        id (int | str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[BlockingReasonResponse | ProblemDetails]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    id: int | str,
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> BlockingReasonResponse | ProblemDetails | None:
+    """ Get a blocking reason
+
+     Retrieves a specific blocking reason by ID, such as Totalskadet køretøj or Mangel.
+
+    Args:
+        id (int | str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        BlockingReasonResponse | ProblemDetails
+     """
+
+
+    return (await asyncio_detailed(
+        id=id,
+client=client,
+
+    )).parsed