pazufa-corelib 0.1.0__py3-none-any.whl

pazufa_corelib/__init__.py

@@ -0,0 +1,19 @@
+"""pazufa_corelib - Core library for collecting parliamentary data.
+
+LLM enrichment functionality is available via the ``pazufa_corelib.llm``
+subpackage (models, prompts, taxonomy, and connector).
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from pazufa_corelib.api_helpers import format_if_modified_since
+
+try:
+    __version__ = version("pazufa_corelib")
+except PackageNotFoundError:
+    __version__ = "0.0.0+unknown"
+
+__all__ = [
+    "__version__",
+    "format_if_modified_since",
+]

pazufa_corelib/api_client/__init__.py

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

pazufa_corelib/api_client/api/__init__.py

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

pazufa_corelib/api_client/api/authentifizierung/__init__.py

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

pazufa_corelib/api_client/api/authentifizierung/auth_delete.py

@@ -0,0 +1,106 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    api_key_delete: str,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    headers["api-key-delete"] = api_key_delete
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/v2/auth",
+    }
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 204:
+        return None
+
+    if response.status_code == 403:
+        return None
+
+    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[Any]:
+    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,
+    api_key_delete: str,
+) -> Response[Any]:
+    """Key adder interface for removing API keys from the system. Allows administrators and key management
+    services to revoke access by deleting an existing API key.
+
+    Args:
+        api_key_delete (str): A uniquely identifying string that is generated from key data within
+            the database
+
+    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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        api_key_delete=api_key_delete,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    api_key_delete: str,
+) -> Response[Any]:
+    """Key adder interface for removing API keys from the system. Allows administrators and key management
+    services to revoke access by deleting an existing API key.
+
+    Args:
+        api_key_delete (str): A uniquely identifying string that is generated from key data within
+            the database
+
+    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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        api_key_delete=api_key_delete,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

pazufa_corelib/api_client/api/authentifizierung/auth_listing.py

@@ -0,0 +1,211 @@
+import datetime
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    since: datetime.datetime | Unset = UNSET,
+    until: datetime.datetime | Unset = UNSET,
+    page: int | Unset = 1,
+    per_page: int | Unset = 32,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_since: str | Unset = UNSET
+    if not isinstance(since, Unset):
+        json_since = since.isoformat()
+    params["since"] = json_since
+
+    json_until: str | Unset = UNSET
+    if not isinstance(until, Unset):
+        json_until = until.isoformat()
+    params["until"] = json_until
+
+    params["page"] = page
+
+    params["per_page"] = per_page
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v2/auth/keys",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | list[str] | None:
+    if response.status_code == 200:
+        response_200 = cast(list[str], response.json())
+
+        return response_200
+
+    if response.status_code == 403:
+        response_403 = cast(Any, None)
+        return response_403
+
+    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[Any | list[str]]:
+    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,
+    since: datetime.datetime | Unset = UNSET,
+    until: datetime.datetime | Unset = UNSET,
+    page: int | Unset = 1,
+    per_page: int | Unset = 32,
+) -> Response[Any | list[str]]:
+    """Retrieve a list of Keys that are currently in Use
+
+    Args:
+        since (datetime.datetime | Unset):  Example: 2024-01-01T00:00:00+00:00.
+        until (datetime.datetime | Unset):  Example: 2024-12-31T23:59:59+00:00.
+        page (int | Unset):  Default: 1.
+        per_page (int | Unset):  Default: 32.
+
+    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[Any | list[str]]
+    """
+
+    kwargs = _get_kwargs(
+        since=since,
+        until=until,
+        page=page,
+        per_page=per_page,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    since: datetime.datetime | Unset = UNSET,
+    until: datetime.datetime | Unset = UNSET,
+    page: int | Unset = 1,
+    per_page: int | Unset = 32,
+) -> Any | list[str] | None:
+    """Retrieve a list of Keys that are currently in Use
+
+    Args:
+        since (datetime.datetime | Unset):  Example: 2024-01-01T00:00:00+00:00.
+        until (datetime.datetime | Unset):  Example: 2024-12-31T23:59:59+00:00.
+        page (int | Unset):  Default: 1.
+        per_page (int | Unset):  Default: 32.
+
+    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:
+        Any | list[str]
+    """
+
+    return sync_detailed(
+        client=client,
+        since=since,
+        until=until,
+        page=page,
+        per_page=per_page,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    since: datetime.datetime | Unset = UNSET,
+    until: datetime.datetime | Unset = UNSET,
+    page: int | Unset = 1,
+    per_page: int | Unset = 32,
+) -> Response[Any | list[str]]:
+    """Retrieve a list of Keys that are currently in Use
+
+    Args:
+        since (datetime.datetime | Unset):  Example: 2024-01-01T00:00:00+00:00.
+        until (datetime.datetime | Unset):  Example: 2024-12-31T23:59:59+00:00.
+        page (int | Unset):  Default: 1.
+        per_page (int | Unset):  Default: 32.
+
+    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[Any | list[str]]
+    """
+
+    kwargs = _get_kwargs(
+        since=since,
+        until=until,
+        page=page,
+        per_page=per_page,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    since: datetime.datetime | Unset = UNSET,
+    until: datetime.datetime | Unset = UNSET,
+    page: int | Unset = 1,
+    per_page: int | Unset = 32,
+) -> Any | list[str] | None:
+    """Retrieve a list of Keys that are currently in Use
+
+    Args:
+        since (datetime.datetime | Unset):  Example: 2024-01-01T00:00:00+00:00.
+        until (datetime.datetime | Unset):  Example: 2024-12-31T23:59:59+00:00.
+        page (int | Unset):  Default: 1.
+        per_page (int | Unset):  Default: 32.
+
+    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:
+        Any | list[str]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            since=since,
+            until=until,
+            page=page,
+            per_page=per_page,
+        )
+    ).parsed

pazufa_corelib/api_client/api/authentifizierung/auth_listing_keytag.py

@@ -0,0 +1,159 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.auth_listing_keytag_response_200 import AuthListingKeytagResponse200
+from ...types import Response
+
+
+def _get_kwargs(
+    keytag: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v2/auth/keys/{keytag}".format(
+            keytag=quote(str(keytag), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | AuthListingKeytagResponse200 | None:
+    if response.status_code == 200:
+        response_200 = AuthListingKeytagResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 403:
+        response_403 = cast(Any, None)
+        return response_403
+
+    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[Any | AuthListingKeytagResponse200]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    keytag: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Any | AuthListingKeytagResponse200]:
+    """Retrieve a detailed overview of the objects changed by this key
+
+    Args:
+        keytag (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[Any | AuthListingKeytagResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        keytag=keytag,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    keytag: str,
+    *,
+    client: AuthenticatedClient,
+) -> Any | AuthListingKeytagResponse200 | None:
+    """Retrieve a detailed overview of the objects changed by this key
+
+    Args:
+        keytag (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:
+        Any | AuthListingKeytagResponse200
+    """
+
+    return sync_detailed(
+        keytag=keytag,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    keytag: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Any | AuthListingKeytagResponse200]:
+    """Retrieve a detailed overview of the objects changed by this key
+
+    Args:
+        keytag (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[Any | AuthListingKeytagResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        keytag=keytag,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    keytag: str,
+    *,
+    client: AuthenticatedClient,
+) -> Any | AuthListingKeytagResponse200 | None:
+    """Retrieve a detailed overview of the objects changed by this key
+
+    Args:
+        keytag (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:
+        Any | AuthListingKeytagResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            keytag=keytag,
+            client=client,
+        )
+    ).parsed

pazufa_corelib/api_client/api/authentifizierung/auth_post.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_api_key import CreateApiKey
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: CreateApiKey,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v2/auth",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | str | None:
+    if response.status_code == 201:
+        response_201 = response.text
+        return response_201
+
+    if response.status_code == 403:
+        response_403 = cast(Any, None)
+        return response_403
+
+    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[Any | str]:
+    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,
+    body: CreateApiKey,
+) -> Response[Any | str]:
+    """Key adder interface for creating new API keys. Allows administrators to generate new access keys for
+    collectors, administrative tools, or other key adders.
+
+    Args:
+        body (CreateApiKey): Fragt einen neuen API-Key an. Dieser wird gehasht in der Datenbank
+            gespeichert und wird nur einmalig in Klartext ausgegeben
+
+    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[Any | str]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: CreateApiKey,
+) -> Any | str | None:
+    """Key adder interface for creating new API keys. Allows administrators to generate new access keys for
+    collectors, administrative tools, or other key adders.
+
+    Args:
+        body (CreateApiKey): Fragt einen neuen API-Key an. Dieser wird gehasht in der Datenbank
+            gespeichert und wird nur einmalig in Klartext ausgegeben
+
+    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:
+        Any | str
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: CreateApiKey,
+) -> Response[Any | str]:
+    """Key adder interface for creating new API keys. Allows administrators to generate new access keys for
+    collectors, administrative tools, or other key adders.
+
+    Args:
+        body (CreateApiKey): Fragt einen neuen API-Key an. Dieser wird gehasht in der Datenbank
+            gespeichert und wird nur einmalig in Klartext ausgegeben
+
+    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[Any | str]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: CreateApiKey,
+) -> Any | str | None:
+    """Key adder interface for creating new API keys. Allows administrators to generate new access keys for
+    collectors, administrative tools, or other key adders.
+
+    Args:
+        body (CreateApiKey): Fragt einen neuen API-Key an. Dieser wird gehasht in der Datenbank
+            gespeichert und wird nur einmalig in Klartext ausgegeben
+
+    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:
+        Any | str
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed