clockster 0.1.0__py3-none-any.whl

clockster/__init__.py

@@ -0,0 +1,52 @@
+"""Official Python SDK for the Clockster Company API.
+
+    from clockster import Clockster
+
+    clockster = Clockster(token=os.environ["CLOCKSTER_TOKEN"])
+    users = clockster.users.list(per_page=100, include=["location"])
+
+Typed from https://api.clockster.com/openapi/v3.json. The answer is the parsed body, nothing is
+validated on the way in, and a refusal is raised as a `ClocksterError`.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+from ._client import AsyncClockster, Clockster
+from ._transport import DEFAULT_BASE_URL
+from .errors import (
+    AuthenticationError,
+    ClocksterError,
+    ConflictError,
+    ForbiddenError,
+    NotFoundError,
+    RateLimitError,
+    ServerError,
+    ValidationError,
+)
+from .pagination import paginate, paginate_async
+from .webhooks import WebhookVerificationError, verify_webhook
+
+__all__ = [
+    "DEFAULT_BASE_URL",
+    "AsyncClockster",
+    "AuthenticationError",
+    "Clockster",
+    "ClocksterError",
+    "ConflictError",
+    "ForbiddenError",
+    "NotFoundError",
+    "RateLimitError",
+    "ServerError",
+    "ValidationError",
+    "WebhookVerificationError",
+    "paginate",
+    "paginate_async",
+    "verify_webhook",
+]
+
+try:
+    __version__ = version("clockster")
+except PackageNotFoundError:  # pragma: no cover - a source tree nobody installed
+    __version__ = "0.0.0"

clockster/_client.py

@@ -0,0 +1,96 @@
+"""The client a caller constructs. Everything below the constructor is generated."""
+
+from __future__ import annotations
+
+from types import TracebackType
+
+import httpx
+
+from ._generated.api import _AsyncClocksterApi, _ClocksterApi
+from ._transport import DEFAULT_BASE_URL, DEFAULT_TIMEOUT, _AsyncTransport, _SyncTransport
+
+
+class Clockster(_ClocksterApi):
+    """The Company API, one token to one company.
+
+    The key is issued in the web application, under Settings, API.
+
+        clockster = Clockster(token=os.environ["CLOCKSTER_TOKEN"])
+        me = clockster.me()
+        users = clockster.users.list(per_page=100, include=["location"])
+
+    Every method answers the parsed body — `users["data"]` is the rows — and raises
+    `ClocksterError` on a refusal. Deliveries are verified with `verify_webhook`.
+    """
+
+    def __init__(
+        self,
+        token: str,
+        *,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = DEFAULT_TIMEOUT,
+        client: httpx.Client | None = None,
+    ) -> None:
+        """
+        :param token: the company API key.
+        :param base_url: point at a demo stand instead of production.
+        :param timeout: seconds, applied to each request.
+        :param client: your own httpx client — a proxy, a retrying transport, a recording one.
+            Supplying one leaves closing it to you.
+        """
+        self._sync_transport = _SyncTransport(
+            token, base_url=base_url, timeout=timeout, client=client
+        )
+
+        super().__init__(self._sync_transport)
+
+    def close(self) -> None:
+        """Close the connection pool, unless the httpx client came from outside."""
+        self._sync_transport.close()
+
+    def __enter__(self) -> Clockster:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        self.close()
+
+
+class AsyncClockster(_AsyncClocksterApi):
+    """The same API, awaited.
+
+    async with AsyncClockster(token=...) as clockster:
+        users = await clockster.users.list(per_page=100)
+    """
+
+    def __init__(
+        self,
+        token: str,
+        *,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = DEFAULT_TIMEOUT,
+        client: httpx.AsyncClient | None = None,
+    ) -> None:
+        self._async_transport = _AsyncTransport(
+            token, base_url=base_url, timeout=timeout, client=client
+        )
+
+        super().__init__(self._async_transport)
+
+    async def aclose(self) -> None:
+        await self._async_transport.aclose()
+
+    async def __aenter__(self) -> AsyncClockster:
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        await self.aclose()

clockster/_generated/__init__.py

@@ -0,0 +1 @@
+"""Generated from the specification; do not edit by hand."""