streamflow-pulse-client 2.5.8__py3-none-any.whl

pulse_client/__init__.py

@@ -0,0 +1,41 @@
+"""Official Python client for StreamFlow Pulse.
+
+Quick start:
+
+    >>> from pulse_client import PulseClient
+    >>> client = PulseClient("http://localhost:9090")
+    >>> client.auth.login("alice", "secret")
+    >>> for pipeline in client.pipelines.list():
+    ...     print(pipeline["name"])
+    >>> client.close()
+
+Or as a context manager:
+
+    >>> with PulseClient("http://localhost:9090", token="ey...") as client:
+    ...     print(client.version())
+
+See README.md for the full surface.
+"""
+
+from pulse_client.client import PulseClient
+from pulse_client.exceptions import (
+    PulseAPIError,
+    PulseAuthError,
+    PulseClientError,
+    PulseNotFoundError,
+    PulseRateLimitError,
+    PulseValidationError,
+)
+
+__version__ = "2.5.8"
+
+__all__ = [
+    "PulseClient",
+    "PulseAPIError",
+    "PulseAuthError",
+    "PulseClientError",
+    "PulseNotFoundError",
+    "PulseRateLimitError",
+    "PulseValidationError",
+    "__version__",
+]

pulse_client/client.py

@@ -0,0 +1,455 @@
+"""The main ``PulseClient`` and its sub-resource accessors.
+
+Design: every API surface (auth, pipelines, agents, etc.) is its own small
+class accessed via an attribute on the client (``client.pipelines``,
+``client.agents``). The classes share the HTTP transport via composition
+rather than inheritance — keeps each resource focused.
+
+The wire format is the Pulse REST surface described by
+``streamflow-pulse/src/main/resources/openapi/openapi.yaml`` (B-103). When
+a new endpoint lands in the spec, add a method here and a matching test.
+"""
+
+from __future__ import annotations
+
+import json
+from collections.abc import Iterator
+from types import TracebackType
+from typing import Any, cast
+
+import httpx
+
+from pulse_client.exceptions import (
+    PulseAPIError,
+    PulseAuthError,
+    PulseNotFoundError,
+    PulseRateLimitError,
+    PulseValidationError,
+)
+
+DEFAULT_TIMEOUT = 30.0
+USER_AGENT = "pulse-client-python/2.5.8"
+
+
+class PulseClient:
+    """Synchronous HTTP client for the Pulse REST API.
+
+    Args:
+        base_url: The Pulse server URL (e.g. ``http://localhost:9090``).
+        token: Optional JWT to attach as ``Authorization: Bearer <token>``
+            on every request. If omitted, call :meth:`auth.login` first.
+        timeout: Per-request timeout in seconds. Default 30.
+        verify: TLS verification (passed through to httpx). Set to ``False``
+            for self-signed certs in dev.
+
+    Example:
+        >>> from pulse_client import PulseClient
+        >>> with PulseClient("http://localhost:9090") as client:
+        ...     client.auth.login("alice", "secret")
+        ...     for pipeline in client.pipelines.list():
+        ...         print(pipeline["name"])
+    """
+
+    def __init__(
+        self,
+        base_url: str,
+        *,
+        token: str | None = None,
+        timeout: float = DEFAULT_TIMEOUT,
+        verify: bool | str = True,
+    ) -> None:
+        self._base_url = base_url.rstrip("/")
+        self._token = token
+        self._http = httpx.Client(
+            base_url=self._base_url,
+            timeout=timeout,
+            verify=verify,
+            headers={"User-Agent": USER_AGENT},
+        )
+        # Resource accessors — each one shares the same transport.
+        self.auth = _AuthResource(self)
+        self.pipelines = _PipelinesResource(self)
+        self.agents = _AgentsResource(self)
+        self.templates = _TemplatesResource(self)
+        self.users = _UsersResource(self)
+        self.events = _EventsResource(self)
+
+    # ------------------------------------------------------------------
+    # Lifecycle
+    # ------------------------------------------------------------------
+    def __enter__(self) -> PulseClient:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        self.close()
+
+    def close(self) -> None:
+        """Close the underlying HTTP connection pool."""
+        self._http.close()
+
+    # ------------------------------------------------------------------
+    # Public API: top-level endpoints
+    # ------------------------------------------------------------------
+    def version(self) -> dict[str, Any]:
+        """Returns the Pulse server's build + version metadata.
+
+        This is a public endpoint — no JWT required.
+        """
+        return cast(
+            "dict[str, Any]",
+            self._request("GET", "/api/pulse/version", authenticated=False),
+        )
+
+    @property
+    def token(self) -> str | None:
+        """The currently-set bearer token, if any."""
+        return self._token
+
+    @token.setter
+    def token(self, value: str | None) -> None:
+        self._token = value
+
+    # ------------------------------------------------------------------
+    # Internal: request execution + error translation
+    # ------------------------------------------------------------------
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        json: Any = None,
+        params: dict[str, Any] | None = None,
+        authenticated: bool = True,
+    ) -> Any:
+        """Issues an HTTP request and translates errors to typed exceptions.
+
+        Returns the parsed JSON body for 2xx responses, or ``None`` for
+        204 No Content.
+        """
+        headers: dict[str, str] = {}
+        if authenticated:
+            if not self._token:
+                raise PulseAuthError(
+                    status_code=401,
+                    path=path,
+                    body={"error": "No token set. Call client.auth.login() first or pass token=..."},
+                )
+            headers["Authorization"] = f"Bearer {self._token}"
+
+        response = self._http.request(
+            method,
+            path,
+            json=json,
+            params=params,
+            headers=headers,
+        )
+
+        if response.status_code == 204:
+            return None
+
+        if 200 <= response.status_code < 300:
+            if not response.content:
+                return None
+            try:
+                return response.json()
+            except ValueError:
+                return response.text
+
+        # Translate error → typed exception
+        self._raise_for_error(response, path)
+        # _raise_for_error always raises; this is for type-checker happiness
+        raise PulseAPIError(response.status_code, path)
+
+    @staticmethod
+    def _raise_for_error(response: httpx.Response, path: str) -> None:
+        body: dict[str, Any] | str | None
+        try:
+            body = response.json()
+        except ValueError:
+            body = response.text or None
+
+        if response.status_code == 401:
+            raise PulseAuthError(response.status_code, path, body)
+        if response.status_code == 404:
+            raise PulseNotFoundError(response.status_code, path, body)
+        if response.status_code == 400:
+            raise PulseValidationError(response.status_code, path, body)
+        if response.status_code == 429:
+            retry_after: int | None = None
+            if isinstance(body, dict):
+                value = body.get("retryAfterSeconds")
+                if isinstance(value, (int, float)):
+                    retry_after = int(value)
+            if retry_after is None:
+                header = response.headers.get("Retry-After")
+                if header is not None:
+                    try:
+                        retry_after = int(header)
+                    except ValueError:
+                        retry_after = None
+            raise PulseRateLimitError(response.status_code, path, body, retry_after)
+        raise PulseAPIError(response.status_code, path, body)
+
+
+# ----------------------------------------------------------------------
+# Resource classes — one per OpenAPI tag.
+# ----------------------------------------------------------------------
+
+
+class _Resource:
+    """Shared base — holds a back-reference to the parent client."""
+
+    def __init__(self, client: PulseClient) -> None:
+        self._client = client
+
+
+class _AuthResource(_Resource):
+    """``client.auth`` — authentication + session management."""
+
+    def login(self, username: str, password: str) -> dict[str, Any]:
+        """POST /api/auth/login — exchanges credentials for a JWT.
+
+        On success, the returned token is cached on the parent client so
+        subsequent calls authenticate automatically. The full response
+        (including ``refreshToken`` and ``activeOrg``) is returned to the
+        caller for downstream use.
+        """
+        response = cast(
+            "dict[str, Any]",
+            self._client._request(
+                "POST",
+                "/api/auth/login",
+                json={"username": username, "password": password},
+                authenticated=False,
+            ),
+        )
+        token = response.get("token") if isinstance(response, dict) else None
+        if token:
+            self._client.token = token
+        return response
+
+    def refresh(self, refresh_token: str) -> dict[str, Any]:
+        """POST /api/auth/refresh — exchanges a refresh token for a fresh JWT.
+
+        The new ``token`` is cached on the parent client.
+        """
+        response = cast(
+            "dict[str, Any]",
+            self._client._request(
+                "POST",
+                "/api/auth/refresh",
+                json={"refreshToken": refresh_token},
+                authenticated=False,
+            ),
+        )
+        token = response.get("token") if isinstance(response, dict) else None
+        if token:
+            self._client.token = token
+        return response
+
+    def organizations(self) -> list[dict[str, Any]]:
+        """GET /api/auth/organizations — orgs the current user is a member of."""
+        result = self._client._request("GET", "/api/auth/organizations")
+        if isinstance(result, dict):
+            orgs = result.get("organizations", [])
+            if isinstance(orgs, list):
+                return cast("list[dict[str, Any]]", orgs)
+        return []
+
+    def switch_org(self, org_id: str) -> dict[str, Any]:
+        """POST /api/auth/switch-org — switches the active org.
+
+        The new JWT (with updated ``orgId`` claim) is cached on the parent client.
+        """
+        response = cast(
+            "dict[str, Any]",
+            self._client._request(
+                "POST",
+                "/api/auth/switch-org",
+                json={"orgId": org_id},
+            ),
+        )
+        token = response.get("token") if isinstance(response, dict) else None
+        if token:
+            self._client.token = token
+        return response
+
+
+class _PipelinesResource(_Resource):
+    """``client.pipelines`` — create / list / inspect / delete pipelines."""
+
+    def list(self) -> list[dict[str, Any]]:
+        """GET /api/pulse/pipelines — every pipeline in the current org."""
+        result = self._client._request("GET", "/api/pulse/pipelines")
+        if isinstance(result, dict):
+            pipelines = result.get("pipelines", [])
+            if isinstance(pipelines, list):
+                return cast("list[dict[str, Any]]", pipelines)
+        return []
+
+    def get(self, pipeline_id: str) -> dict[str, Any]:
+        """GET /api/pulse/pipelines/{id} — one pipeline by id."""
+        return cast(
+            "dict[str, Any]",
+            self._client._request("GET", f"/api/pulse/pipelines/{pipeline_id}"),
+        )
+
+    def create(self, definition: dict[str, Any]) -> dict[str, Any]:
+        """POST /api/pulse/pipelines — creates + deploys a new pipeline.
+
+        ``definition`` must follow the CreatePipelineRequest schema
+        (see /openapi.yaml). At minimum: ``name`` + ``nodes``.
+        """
+        return cast(
+            "dict[str, Any]",
+            self._client._request("POST", "/api/pulse/pipelines", json=definition),
+        )
+
+    def delete(self, pipeline_id: str) -> None:
+        """DELETE /api/pulse/pipelines/{id} — tears down the pipeline."""
+        self._client._request("DELETE", f"/api/pulse/pipelines/{pipeline_id}")
+
+
+class _AgentsResource(_Resource):
+    """``client.agents`` — inspect deployed agents (read-only)."""
+
+    def list(self) -> list[dict[str, Any]]:
+        """GET /api/pulse/agents — every deployed agent in the current org."""
+        result = self._client._request("GET", "/api/pulse/agents")
+        if isinstance(result, dict):
+            agents = result.get("agents", [])
+            if isinstance(agents, list):
+                return cast("list[dict[str, Any]]", agents)
+        return []
+
+    def get(self, agent_id: str) -> dict[str, Any]:
+        """GET /api/pulse/agents/{id} — one agent by id."""
+        return cast(
+            "dict[str, Any]",
+            self._client._request("GET", f"/api/pulse/agents/{agent_id}"),
+        )
+
+
+class _TemplatesResource(_Resource):
+    """``client.templates`` — first-party pipeline template catalog."""
+
+    def list(self) -> list[dict[str, Any]]:
+        """GET /api/pulse/templates — the 223+ first-party templates."""
+        result = self._client._request("GET", "/api/pulse/templates")
+        if isinstance(result, dict):
+            templates = result.get("templates", [])
+            if isinstance(templates, list):
+                return cast("list[dict[str, Any]]", templates)
+        return []
+
+
+class _UsersResource(_Resource):
+    """``client.users`` — user management (admin only)."""
+
+    def list(self) -> list[dict[str, Any]]:
+        """GET /api/pulse/users — every user in the current org.
+
+        Requires the caller to have the ``USERS_LIST`` permission atom (Owner
+        and Platform Admin personas by default — see B-105).
+        """
+        result = self._client._request("GET", "/api/pulse/users")
+        if isinstance(result, dict):
+            users = result.get("users", [])
+            if isinstance(users, list):
+                return cast("list[dict[str, Any]]", users)
+        return []
+
+
+class _EventsResource(_Resource):
+    """``client.events`` — live SSE stream of events flowing through the engine.
+
+    Usage:
+
+        >>> with PulseClient("http://localhost:9090", token=token) as client:
+        ...     for event in client.events.stream():
+        ...         print(event["type"], event.get("payload"))
+
+    The stream blocks the calling thread (synchronous generator). For an
+    async iterator using ``httpx.AsyncClient``, see ``pulse_client.async_events``
+    (planned for v3.0 alongside ``AsyncPulseClient``).
+
+    Cancellation: break out of the for-loop. The underlying HTTP connection
+    is closed by the generator's ``__exit__``.
+    """
+
+    def stream(
+        self,
+        *,
+        timeout: float | None = None,
+    ) -> Iterator[dict[str, Any]]:
+        """Subscribes to ``GET /api/pulse/events/stream`` and yields events.
+
+        Args:
+            timeout: Per-read timeout in seconds. ``None`` disables (the
+                connection stays open until the server closes it or the
+                caller breaks out of the loop). Default: inherit the client
+                timeout (which itself defaults to 30s — likely too short
+                for long-running streams; override here).
+
+        Yields:
+            One dict per event, parsed from the SSE ``data: ...`` line.
+            Heartbeat lines, comments (``:keep-alive``), and SSE-control
+            fields (``event:``, ``id:``, ``retry:``) are silently
+            consumed but not yielded.
+
+        Raises:
+            PulseAuthError: If no token is set or the server rejects it.
+            PulseAPIError: If the server returns a non-2xx response.
+        """
+        client = self._client
+        if not client._token:
+            raise PulseAuthError(
+                status_code=401,
+                path="/api/pulse/events/stream",
+                body={"error": "No token set for SSE stream"},
+            )
+        headers = {
+            "Authorization": f"Bearer {client._token}",
+            "Accept": "text/event-stream",
+            "Cache-Control": "no-cache",
+        }
+        with client._http.stream(
+            "GET",
+            "/api/pulse/events/stream",
+            headers=headers,
+            timeout=timeout if timeout is not None else client._http.timeout,
+        ) as response:
+            if response.status_code >= 400:
+                response.read()
+                client._raise_for_error(response, "/api/pulse/events/stream")
+                return
+
+            # SSE parser — accumulate `data:` lines per event, dispatch on
+            # blank line. See https://html.spec.whatwg.org/multipage/server-sent-events.html
+            data_lines: list[str] = []
+            for raw_line in response.iter_lines():
+                if raw_line is None:
+                    continue
+                if raw_line == "":
+                    # Event boundary — assemble and yield
+                    if data_lines:
+                        payload = "\n".join(data_lines)
+                        data_lines = []
+                        try:
+                            yield json.loads(payload)
+                        except ValueError:
+                            # Non-JSON event payload — surface as raw string
+                            yield {"data": payload}
+                    continue
+                if raw_line.startswith(":"):
+                    continue  # SSE comment / keep-alive
+                if raw_line.startswith("data:"):
+                    data_lines.append(raw_line[5:].lstrip())
+                # Other SSE fields (`event:`, `id:`, `retry:`) are
+                # consumed but not surfaced — Pulse's server doesn't use
+                # them today. Add explicit dispatch when it does.

pulse_client/exceptions.py

@@ -0,0 +1,77 @@
+"""Typed exception hierarchy for the Pulse client.
+
+Every HTTP error from the server is translated into one of these. They all
+inherit from :class:`PulseClientError` so callers can catch the entire
+client-side family in one block.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class PulseClientError(Exception):
+    """Base class for every exception raised by this library."""
+
+
+class PulseAPIError(PulseClientError):
+    """A non-2xx response from the Pulse server.
+
+    Carries the status code, the parsed error body (if JSON), and the
+    request path so log lines + bug reports are actionable.
+    """
+
+    def __init__(
+        self,
+        status_code: int,
+        path: str,
+        body: dict[str, Any] | str | None = None,
+    ) -> None:
+        self.status_code = status_code
+        self.path = path
+        self.body = body
+        message = self._format_message(status_code, path, body)
+        super().__init__(message)
+
+    @staticmethod
+    def _format_message(
+        status_code: int, path: str, body: dict[str, Any] | str | None
+    ) -> str:
+        msg = f"HTTP {status_code} from {path}"
+        if isinstance(body, dict):
+            err = body.get("error") or body.get("errorMessage") or body.get("message")
+            if err:
+                msg += f" — {err}"
+        elif isinstance(body, str) and body:
+            msg += f" — {body[:200]}"
+        return msg
+
+
+class PulseAuthError(PulseAPIError):
+    """The server returned 401 — invalid / expired / missing JWT."""
+
+
+class PulseNotFoundError(PulseAPIError):
+    """The server returned 404 — the resource does not exist."""
+
+
+class PulseValidationError(PulseAPIError):
+    """The server returned 400 — the request body is malformed."""
+
+
+class PulseRateLimitError(PulseAPIError):
+    """The server returned 429 — per-user or per-IP rate limit hit.
+
+    Carries the ``retry_after_seconds`` value the server advises waiting
+    before retrying (parsed from the JSON body or the ``Retry-After`` header).
+    """
+
+    def __init__(
+        self,
+        status_code: int,
+        path: str,
+        body: dict[str, Any] | str | None,
+        retry_after_seconds: int | None,
+    ) -> None:
+        super().__init__(status_code, path, body)
+        self.retry_after_seconds = retry_after_seconds

streamflow_pulse_client-2.5.8.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: streamflow-pulse-client
+Version: 2.5.8
+Summary: Official Python client for StreamFlow Pulse — AI Agent Platform
+Project-URL: Homepage, https://github.com/olsisoft/streamflow
+Project-URL: Documentation, https://github.com/olsisoft/streamflow/blob/dev/pulse-py/README.md
+Project-URL: Source, https://github.com/olsisoft/streamflow/tree/dev/pulse-py
+Project-URL: Issues, https://github.com/olsisoft/streamflow/issues
+Author-email: Njong Michael <mike.njo@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,llm,mcp,pipelines,pulse,streamflow
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx<1.0,>=0.27
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.1; extra == 'test'
+Requires-Dist: pytest>=7.4; extra == 'test'
+Requires-Dist: respx>=0.21; extra == 'test'
+Description-Content-Type: text/markdown
+
+# streamflow-pulse-client — Python SDK for StreamFlow Pulse
+
+Official Python client for the [Pulse](https://github.com/olsisoft/streamflow) AI Agent Platform.
+
+**Distribution name** on PyPI is `streamflow-pulse-client`; **import statement** stays the natural `from pulse_client import ...` (same convention as `python-dateutil` → `import dateutil`).
+
+```python
+from pulse_client import PulseClient
+
+with PulseClient("http://localhost:9090") as client:
+    client.auth.login("alice", "secret")
+    for pipeline in client.pipelines.list():
+        print(pipeline["name"])
+```
+
+## Install
+
+```bash
+pip install streamflow-pulse-client
+```
+
+Requires Python **3.10+**. Pure Python — only depends on `httpx`.
+
+## Why pulse-client
+
+- **Pythonic** — context-manager friendly, typed exceptions, attribute-style resource access (`client.pipelines.list()`).
+- **Lightweight** — single dependency (`httpx`), <500 LoC, no generated bloat.
+- **Spec-aligned** — every method corresponds 1:1 to an endpoint in the [Pulse OpenAPI 3.1 spec](../streamflow-pulse/src/main/resources/openapi/openapi.yaml). Drift is caught at PR time by the in-tree spec invariant tests (B-103).
+- **Async-ready** — the sync client ships today; an `AsyncPulseClient` (same surface, `await` everywhere) will follow in v3.0.
+
+## Quick start
+
+```python
+from pulse_client import PulseClient, PulseAuthError
+
+client = PulseClient("http://localhost:9090")
+
+# Authenticate — the returned JWT is cached on the client automatically
+try:
+    response = client.auth.login("alice", "secret")
+    print(f"Logged in as {response['user']['username']}")
+except PulseAuthError as e:
+    print(f"Login failed: {e}")
+
+# List + inspect resources
+for pipeline in client.pipelines.list():
+    print(pipeline["name"], pipeline["status"])
+
+# Create a pipeline from a template
+new_pipeline = client.pipelines.create({
+    "name": "my-fraud-detector",
+    "templateId": "fintech-fraud-detection-realtime",
+    "nodes": [
+        {"id": "source", "type": "source", "subType": "kafka-source"},
+        {"id": "agent", "type": "agent", "subType": "streaming"},
+        {"id": "sink", "type": "sink", "subType": "telegram"},
+    ],
+})
+
+# Inspect deployed agents
+for agent in client.agents.list():
+    print(f"  {agent['name']} — {agent['engineType']} — {agent['status']}")
+
+client.close()
+```
+
+## Supported surfaces (v2.5.8)
+
+| Resource | Methods | Notes |
+|---|---|---|
+| `client.auth` | `login()`, `refresh()`, `organizations()`, `switch_org()` | Auto-caches JWT on the client after `login` / `refresh` / `switch_org`. |
+| `client.pipelines` | `list()`, `get(id)`, `create(definition)`, `delete(id)` | `definition` follows the `CreatePipelineRequest` schema (see OpenAPI spec). |
+| `client.agents` | `list()`, `get(id)` | Read-only — agents are owned by pipelines. |
+| `client.templates` | `list()` | The 223+ first-party templates. |
+| `client.users` | `list()` | Requires `USERS_LIST` permission (Owner / Platform Admin personas). |
+| `client.version()` | top-level | Public — no JWT required. |
+
+The full ~112-endpoint surface (admin, audit, backups, chat, workspace, etc.) is documented in the OpenAPI spec at `<pulse-server>/api-docs`. SDK methods for those land opportunistically as user-facing demand surfaces.
+
+## Authentication
+
+Three patterns, pick what fits:
+
+```python
+# 1. Username + password (interactive / CLI tools)
+client = PulseClient("http://localhost:9090")
+client.auth.login("alice", "secret")
+
+# 2. Pre-minted JWT (CI / service accounts)
+client = PulseClient("http://localhost:9090", token="ey...")
+
+# 3. JWT from environment (12-factor apps)
+import os
+client = PulseClient(os.environ["PULSE_URL"], token=os.environ["PULSE_TOKEN"])
+```
+
+For long-running daemons, store the `refreshToken` from `login()` and call `client.auth.refresh(refresh_token)` when the JWT nears expiry (default 1 h TTL).
+
+## Error handling
+
+Every server error becomes a typed exception you can catch precisely:
+
+```python
+from pulse_client import (
+    PulseClientError,   # base — catches every client-side error
+    PulseAuthError,     # 401 — invalid / missing / expired JWT
+    PulseNotFoundError, # 404
+    PulseValidationError, # 400 — malformed request
+    PulseRateLimitError,  # 429 — carries .retry_after_seconds
+    PulseAPIError,      # everything else (5xx, etc.)
+)
+
+try:
+    client.pipelines.get("nope")
+except PulseNotFoundError:
+    print("Doesn't exist — fine")
+except PulseRateLimitError as e:
+    print(f"Backing off {e.retry_after_seconds}s")
+    time.sleep(e.retry_after_seconds or 60)
+except PulseClientError as e:
+    print(f"Something else went wrong: {e}")
+```
+
+Every exception carries `.status_code`, `.path`, and `.body` so log lines + bug reports are actionable.
+
+## Development
+
+```bash
+git clone https://github.com/olsisoft/streamflow.git
+cd streamflow/pulse-py
+
+# Install in editable mode with dev deps
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint
+ruff check src tests
+mypy src
+```
+
+CI runs the same on every push touching `pulse-py/` — see `.github/workflows/pulse-py.yaml`.
+
+## Roadmap
+
+- **v2.5.x** — current sync API, 5 core resources (auth, pipelines, agents, templates, users), `version()`.
+- **v2.6.x** — expanded resource coverage: backups, schedules, credentials, settings, approvals, chat.
+- **v3.0** — `AsyncPulseClient` with `async def` everywhere; same surface; one library, two clients.
+- **B-098 satellite** — once `olsisoft/pulse-py` exists as its own repo, this in-tree code lifts out wholesale. Pip-install will switch to the satellite; in-tree continues to mirror for one release cycle so the migration is non-breaking.
+
+Track progress in [`docs/STREAMFLOW-BACKLOG.md`](../docs/STREAMFLOW-BACKLOG.md) under item **B-098**.
+
+## License
+
+Apache 2.0 — same as the parent Pulse repository.

streamflow_pulse_client-2.5.8.dist-info/RECORD

@@ -0,0 +1,7 @@
+pulse_client/__init__.py,sha256=MldO9V_GLIxq3sGIJ4KaqhbIZrhwvxNY8OzbS3sgeQE,940
+pulse_client/client.py,sha256=l-OGK4Cz4ljrbY3gVv_xidBNIhnpacttC4Nuyq_YRJU,16740
+pulse_client/exceptions.py,sha256=A3qaOQWvJGHiddJswozMo8a17058sghKSPwpkKqpdqg,2307
+streamflow_pulse_client-2.5.8.dist-info/METADATA,sha256=1mN0vxqBwUqePGGR-HBOpw-t73jxUVJoxJBpY137Ab0,7418
+streamflow_pulse_client-2.5.8.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+streamflow_pulse_client-2.5.8.dist-info/licenses/LICENSE,sha256=0k7EFAr1HPL4pMQ46Q5GXg8mIcHwxR1VrZZCNNcDKm8,11298
+streamflow_pulse_client-2.5.8.dist-info/RECORD,,

streamflow_pulse_client-2.5.8.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

streamflow_pulse_client-2.5.8.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer or network failure, or any and all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Njong Michael / StreamflowMesh
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.