transitmatters 0.1.0__py3-none-any.whl

transitmatters/__init__.py

@@ -0,0 +1,21 @@
+"""Python client for the TransitMatters Data Dashboard API.
+
+.. include:: ../../README.md
+   :start-after: <!-- The API docs include this file from here down. -->
+"""
+
+from . import models
+from .client import DEFAULT_BASE_URL, AsyncTransitMatters, TransitMatters
+from .errors import APIError, TransitMattersError
+
+__docformat__ = "google"
+
+# Ordered for the API docs, which list members in this order.
+__all__ = [  # noqa: RUF022
+    "TransitMatters",
+    "AsyncTransitMatters",
+    "APIError",
+    "TransitMattersError",
+    "DEFAULT_BASE_URL",
+    "models",
+]

transitmatters/_generated/__init__.py

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

transitmatters/_generated/api/__init__.py

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

transitmatters/_generated/api/api/__init__.py

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

transitmatters/_generated/api/api/get_aggregate_dwells.py

@@ -0,0 +1,214 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.aggregate_by_date import AggregateByDate
+from ...models.error_response import ErrorResponse
+from ...types import Unset
+import datetime
+
+
+def _get_kwargs(
+    *,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_start_date = start_date.isoformat()
+    params["start_date"] = json_start_date
+
+    json_end_date = end_date.isoformat()
+    params["end_date"] = json_end_date
+
+    json_stop: list[str] | Unset = UNSET
+    if not isinstance(stop, Unset):
+        json_stop = stop
+
+    params["stop"] = json_stop
+
+    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/aggregate/dwells",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | list[AggregateByDate] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for componentsschemas_dwells_aggregate_response_item_data in _response_200:
+            componentsschemas_dwells_aggregate_response_item = (
+                AggregateByDate.from_dict(
+                    componentsschemas_dwells_aggregate_response_item_data
+                )
+            )
+
+            response_200.append(componentsschemas_dwells_aggregate_response_item)
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+
+    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[ErrorResponse | list[AggregateByDate]]:
+    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,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> Response[ErrorResponse | list[AggregateByDate]]:
+    """Retrieve aggregated dwell time data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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[ErrorResponse | list[AggregateByDate]]
+    """
+
+    kwargs = _get_kwargs(
+        start_date=start_date,
+        end_date=end_date,
+        stop=stop,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> ErrorResponse | list[AggregateByDate] | None:
+    """Retrieve aggregated dwell time data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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:
+        ErrorResponse | list[AggregateByDate]
+    """
+
+    return sync_detailed(
+        client=client,
+        start_date=start_date,
+        end_date=end_date,
+        stop=stop,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> Response[ErrorResponse | list[AggregateByDate]]:
+    """Retrieve aggregated dwell time data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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[ErrorResponse | list[AggregateByDate]]
+    """
+
+    kwargs = _get_kwargs(
+        start_date=start_date,
+        end_date=end_date,
+        stop=stop,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> ErrorResponse | list[AggregateByDate] | None:
+    """Retrieve aggregated dwell time data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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:
+        ErrorResponse | list[AggregateByDate]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            start_date=start_date,
+            end_date=end_date,
+            stop=stop,
+        )
+    ).parsed

transitmatters/_generated/api/api/get_aggregate_headways.py

@@ -0,0 +1,214 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.error_response import ErrorResponse
+from ...models.headway_aggregate_by_date import HeadwayAggregateByDate
+from ...types import Unset
+import datetime
+
+
+def _get_kwargs(
+    *,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_start_date = start_date.isoformat()
+    params["start_date"] = json_start_date
+
+    json_end_date = end_date.isoformat()
+    params["end_date"] = json_end_date
+
+    json_stop: list[str] | Unset = UNSET
+    if not isinstance(stop, Unset):
+        json_stop = stop
+
+    params["stop"] = json_stop
+
+    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/aggregate/headways",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | list[HeadwayAggregateByDate] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for componentsschemas_headways_aggregate_response_item_data in _response_200:
+            componentsschemas_headways_aggregate_response_item = (
+                HeadwayAggregateByDate.from_dict(
+                    componentsschemas_headways_aggregate_response_item_data
+                )
+            )
+
+            response_200.append(componentsschemas_headways_aggregate_response_item)
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+
+    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[ErrorResponse | list[HeadwayAggregateByDate]]:
+    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,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> Response[ErrorResponse | list[HeadwayAggregateByDate]]:
+    """Retrieve aggregated headway data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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[ErrorResponse | list[HeadwayAggregateByDate]]
+    """
+
+    kwargs = _get_kwargs(
+        start_date=start_date,
+        end_date=end_date,
+        stop=stop,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> ErrorResponse | list[HeadwayAggregateByDate] | None:
+    """Retrieve aggregated headway data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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:
+        ErrorResponse | list[HeadwayAggregateByDate]
+    """
+
+    return sync_detailed(
+        client=client,
+        start_date=start_date,
+        end_date=end_date,
+        stop=stop,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> Response[ErrorResponse | list[HeadwayAggregateByDate]]:
+    """Retrieve aggregated headway data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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[ErrorResponse | list[HeadwayAggregateByDate]]
+    """
+
+    kwargs = _get_kwargs(
+        start_date=start_date,
+        end_date=end_date,
+        stop=stop,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    stop: list[str] | Unset = UNSET,
+) -> ErrorResponse | list[HeadwayAggregateByDate] | None:
+    """Retrieve aggregated headway data over a date range for the given stop(s).
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        stop (list[str] | Unset):
+
+    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:
+        ErrorResponse | list[HeadwayAggregateByDate]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            start_date=start_date,
+            end_date=end_date,
+            stop=stop,
+        )
+    ).parsed

transitmatters/_generated/api/api/get_aggregate_travel_times.py

@@ -0,0 +1,233 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.aggregate_by_date import AggregateByDate
+from ...models.error_response import ErrorResponse
+from ...types import Unset
+import datetime
+
+
+def _get_kwargs(
+    *,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    from_stop: list[str] | Unset = UNSET,
+    to_stop: list[str] | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_start_date = start_date.isoformat()
+    params["start_date"] = json_start_date
+
+    json_end_date = end_date.isoformat()
+    params["end_date"] = json_end_date
+
+    json_from_stop: list[str] | Unset = UNSET
+    if not isinstance(from_stop, Unset):
+        json_from_stop = from_stop
+
+    params["from_stop"] = json_from_stop
+
+    json_to_stop: list[str] | Unset = UNSET
+    if not isinstance(to_stop, Unset):
+        json_to_stop = to_stop
+
+    params["to_stop"] = json_to_stop
+
+    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/aggregate/traveltimes",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | list[AggregateByDate] | None:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for componentsschemas_travel_time_aggregate_response_item_data in _response_200:
+            componentsschemas_travel_time_aggregate_response_item = (
+                AggregateByDate.from_dict(
+                    componentsschemas_travel_time_aggregate_response_item_data
+                )
+            )
+
+            response_200.append(componentsschemas_travel_time_aggregate_response_item)
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+
+    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[ErrorResponse | list[AggregateByDate]]:
+    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,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    from_stop: list[str] | Unset = UNSET,
+    to_stop: list[str] | Unset = UNSET,
+) -> Response[ErrorResponse | list[AggregateByDate]]:
+    """Retrieve aggregated travel time data over a date range, grouped by date.
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        from_stop (list[str] | Unset):
+        to_stop (list[str] | Unset):
+
+    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[ErrorResponse | list[AggregateByDate]]
+    """
+
+    kwargs = _get_kwargs(
+        start_date=start_date,
+        end_date=end_date,
+        from_stop=from_stop,
+        to_stop=to_stop,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    from_stop: list[str] | Unset = UNSET,
+    to_stop: list[str] | Unset = UNSET,
+) -> ErrorResponse | list[AggregateByDate] | None:
+    """Retrieve aggregated travel time data over a date range, grouped by date.
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        from_stop (list[str] | Unset):
+        to_stop (list[str] | Unset):
+
+    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:
+        ErrorResponse | list[AggregateByDate]
+    """
+
+    return sync_detailed(
+        client=client,
+        start_date=start_date,
+        end_date=end_date,
+        from_stop=from_stop,
+        to_stop=to_stop,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    from_stop: list[str] | Unset = UNSET,
+    to_stop: list[str] | Unset = UNSET,
+) -> Response[ErrorResponse | list[AggregateByDate]]:
+    """Retrieve aggregated travel time data over a date range, grouped by date.
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        from_stop (list[str] | Unset):
+        to_stop (list[str] | Unset):
+
+    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[ErrorResponse | list[AggregateByDate]]
+    """
+
+    kwargs = _get_kwargs(
+        start_date=start_date,
+        end_date=end_date,
+        from_stop=from_stop,
+        to_stop=to_stop,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    start_date: datetime.date,
+    end_date: datetime.date,
+    from_stop: list[str] | Unset = UNSET,
+    to_stop: list[str] | Unset = UNSET,
+) -> ErrorResponse | list[AggregateByDate] | None:
+    """Retrieve aggregated travel time data over a date range, grouped by date.
+
+    Args:
+        start_date (datetime.date):
+        end_date (datetime.date):
+        from_stop (list[str] | Unset):
+        to_stop (list[str] | Unset):
+
+    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:
+        ErrorResponse | list[AggregateByDate]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            start_date=start_date,
+            end_date=end_date,
+            from_stop=from_stop,
+            to_stop=to_stop,
+        )
+    ).parsed