leashbyte-sdk 0.1.1__py3-none-any.whl

leashbyte_sdk/__init__.py

@@ -0,0 +1,54 @@
+"""Public models and client for the LeashByte Python SDK."""
+
+from ._models import (
+    BrowserActionRequest,
+    BrowserCloseResponse,
+    BrowserNode,
+    BrowserSessionRequest,
+    BrowserSessionResponse,
+    BrowserSnapshotResponse,
+    CancelRunRequest,
+    CdpGrantResponse,
+    ConfigResponse,
+    CredentialListResponse,
+    CredentialMetadata,
+    CredentialRequest,
+    FetchRequest,
+    FetchResponse,
+    RunCreateRequest,
+    RunLimits,
+    RunListResponse,
+    RunResponse,
+    SearchResponse,
+    SearchResult,
+    StepResponse,
+)
+from .client import TERMINAL_RUN_STATES, ApiError, LeashByteClient, LeashByteError
+
+__all__ = [
+    "TERMINAL_RUN_STATES",
+    "ApiError",
+    "BrowserActionRequest",
+    "BrowserCloseResponse",
+    "BrowserNode",
+    "BrowserSessionRequest",
+    "BrowserSessionResponse",
+    "BrowserSnapshotResponse",
+    "CancelRunRequest",
+    "CdpGrantResponse",
+    "ConfigResponse",
+    "CredentialListResponse",
+    "CredentialMetadata",
+    "CredentialRequest",
+    "FetchRequest",
+    "FetchResponse",
+    "LeashByteClient",
+    "LeashByteError",
+    "RunCreateRequest",
+    "RunLimits",
+    "RunListResponse",
+    "RunResponse",
+    "SearchResponse",
+    "SearchResult",
+    "StepResponse",
+]

leashbyte_sdk/_models.py

@@ -0,0 +1,264 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.json
+
+from __future__ import annotations
+
+from typing import Annotated, Any, Literal
+
+from pydantic import BaseModel, ConfigDict, Field, RootModel, SecretStr
+
+
+class Mark(RootModel[int]):
+    root: Annotated[int, Field(ge=1, title="Mark")]
+
+
+class Url(RootModel[str]):
+    root: Annotated[str, Field(max_length=2048, title="Url")]
+
+
+class Text(RootModel[str]):
+    root: Annotated[str, Field(max_length=100000, title="Text")]
+
+
+class Values(RootModel[list[str]]):
+    root: Annotated[list[str], Field(max_length=20, title="Values")]
+
+
+class Placeholder(RootModel[str]):
+    root: Annotated[str, Field(max_length=256, title="Placeholder")]
+
+
+class BrowserActionRequest(BaseModel):
+    action: Annotated[
+        Literal["navigate", "click", "type", "select", "scroll", "fill_secret"],
+        Field(title="Action"),
+    ]
+    snapshot_id: Annotated[str, Field(max_length=64, min_length=8, title="Snapshot Id")]
+    mark: Annotated[Mark | None, Field(title="Mark")] = None
+    url: Annotated[Url | None, Field(title="Url")] = None
+    text: Annotated[Text | None, Field(title="Text")] = None
+    values: Annotated[Values | None, Field(title="Values")] = None
+    placeholder: Annotated[Placeholder | None, Field(title="Placeholder")] = None
+    x: Annotated[int | None, Field(ge=-10000, le=10000, title="X")] = 0
+    y: Annotated[int | None, Field(ge=-10000, le=10000, title="Y")] = 0
+
+
+class BrowserCloseResponse(BaseModel):
+    id: Annotated[str, Field(title="Id")]
+    state: Annotated[str, Field(title="State")]
+    profile_released: Annotated[bool, Field(title="Profile Released")]
+
+
+class BrowserNode(BaseModel):
+    mark: Annotated[int, Field(title="Mark")]
+    tag: Annotated[str, Field(title="Tag")]
+    role: Annotated[str, Field(title="Role")]
+    name: Annotated[str, Field(title="Name")]
+    input_type: Annotated[str | None, Field(title="Input Type")]
+
+
+class StartUrl(RootModel[str]):
+    root: Annotated[str, Field(max_length=2048, title="Start Url")]
+
+
+class Proxy(RootModel[str]):
+    root: Annotated[str, Field(max_length=2048, title="Proxy")]
+
+
+class LeaseSeconds(RootModel[int]):
+    root: Annotated[int, Field(ge=30, le=3600, title="Lease Seconds")]
+
+
+class BrowserSessionRequest(BaseModel):
+    profile: Annotated[str, Field(max_length=64, min_length=1, title="Profile")]
+    start_url: Annotated[StartUrl | None, Field(title="Start Url")] = None
+    proxy: Annotated[Proxy | None, Field(title="Proxy")] = None
+    lease_seconds: Annotated[LeaseSeconds | None, Field(title="Lease Seconds")] = None
+
+
+class BrowserSessionResponse(BaseModel):
+    id: Annotated[str, Field(title="Id")]
+    profile: Annotated[str, Field(title="Profile")]
+    state: Annotated[str, Field(title="State")]
+    current_url: Annotated[str, Field(title="Current Url")]
+    expires_at: Annotated[str, Field(title="Expires At")]
+    capabilities: Annotated[list[str], Field(title="Capabilities")]
+
+
+class BrowserSnapshotResponse(BaseModel):
+    session_id: Annotated[str, Field(title="Session Id")]
+    snapshot_id: Annotated[str, Field(title="Snapshot Id")]
+    url: Annotated[str, Field(title="Url")]
+    title: Annotated[str, Field(title="Title")]
+    nodes: Annotated[list[BrowserNode], Field(title="Nodes")]
+
+
+class CancelRunRequest(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    reason: Annotated[str | None, Field(max_length=300, min_length=1, title="Reason")] = (
+        "Cancelled by the user."
+    )
+
+
+class CdpGrantResponse(BaseModel):
+    session_id: Annotated[str, Field(title="Session Id")]
+    token: Annotated[str, Field(title="Token")]
+    expires_in: Annotated[int, Field(title="Expires In")]
+    path: Annotated[str, Field(title="Path")]
+
+
+class ConfigResponse(BaseModel):
+    version: Annotated[str, Field(title="Version")]
+    features: Annotated[dict[str, bool], Field(title="Features")]
+    limits: Annotated[dict[str, int | float], Field(title="Limits")]
+
+
+class CredentialMetadata(BaseModel):
+    alias: Annotated[str, Field(title="Alias")]
+    allowed_origins: Annotated[list[str], Field(title="Allowed Origins")]
+
+
+class CredentialRequest(BaseModel):
+    alias: Annotated[str, Field(max_length=64, min_length=1, title="Alias")]
+    username: Annotated[SecretStr, Field(max_length=4096, min_length=1, title="Username")]
+    password: Annotated[SecretStr, Field(max_length=16384, min_length=1, title="Password")]
+    allowed_origins: Annotated[
+        list[str], Field(max_length=20, min_length=1, title="Allowed Origins")
+    ]
+
+
+class TimeoutSeconds(RootModel[float]):
+    root: Annotated[float, Field(gt=0.0, le=120.0, title="Timeout Seconds")]
+
+
+class MaxBytes(RootModel[int]):
+    root: Annotated[int, Field(gt=0, le=20000000, title="Max Bytes")]
+
+
+class FetchRequest(BaseModel):
+    url: Annotated[str, Field(max_length=2048, min_length=1, title="Url")]
+    format: Annotated[Literal["markdown", "html", "json"] | None, Field(title="Format")] = (
+        "markdown"
+    )
+    timeout_seconds: Annotated[TimeoutSeconds | None, Field(title="Timeout Seconds")] = None
+    max_bytes: Annotated[MaxBytes | None, Field(title="Max Bytes")] = None
+
+
+class FetchResponse(BaseModel):
+    url: Annotated[str, Field(title="Url")]
+    final_url: Annotated[str, Field(title="Final Url")]
+    status: Annotated[int, Field(title="Status")]
+    content_type: Annotated[str, Field(title="Content Type")]
+    format: Annotated[Literal["markdown", "html", "json"], Field(title="Format")]
+    content: Annotated[
+        str | dict[str, Any] | list[Any] | int | float | bool | None,
+        Field(title="Content"),
+    ]
+
+
+class Model(RootModel[str]):
+    root: Annotated[str, Field(max_length=128, title="Model")]
+
+
+class RunLimits(BaseModel):
+    """
+    User limits that the worker cannot exceed.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    steps: Annotated[int | None, Field(ge=1, le=100, title="Steps")] = 12
+    elapsed_seconds: Annotated[int | None, Field(ge=10, le=3600, title="Elapsed Seconds")] = 600
+    tokens: Annotated[int | None, Field(ge=100, le=100000, title="Tokens")] = 12000
+    navigations: Annotated[int | None, Field(ge=0, le=50, title="Navigations")] = 5
+    artifact_bytes: Annotated[int | None, Field(ge=1024, le=20000000, title="Artifact Bytes")] = (
+        5000000
+    )
+
+
+class RunResponse(BaseModel):
+    id: Annotated[str, Field(title="Id")]
+    goal: Annotated[str, Field(title="Goal")]
+    state: Annotated[str, Field(title="State")]
+    created_at: Annotated[str, Field(title="Created At")]
+    started_at: Annotated[str | None, Field(title="Started At")]
+    finished_at: Annotated[str | None, Field(title="Finished At")]
+    provider: Annotated[str, Field(title="Provider")]
+    model: Annotated[str, Field(title="Model")]
+    profile: Annotated[str, Field(title="Profile")]
+    session_id: Annotated[str | None, Field(title="Session Id")]
+    start_url: Annotated[str, Field(title="Start Url")]
+    step_count: Annotated[int, Field(title="Step Count")]
+    usage: Annotated[dict[str, Any], Field(title="Usage")]
+    result: Annotated[dict[str, Any] | None, Field(title="Result")]
+    error: Annotated[str | None, Field(title="Error")]
+    cancellation_reason: Annotated[str | None, Field(title="Cancellation Reason")]
+    artifact_bytes: Annotated[int, Field(title="Artifact Bytes")]
+
+
+class SearchResult(BaseModel):
+    title: Annotated[str, Field(title="Title")]
+    url: Annotated[str, Field(title="Url")]
+    snippet: Annotated[str, Field(title="Snippet")]
+
+
+class StepResponse(BaseModel):
+    number: Annotated[int, Field(title="Number")]
+    snapshot_id: Annotated[str, Field(title="Snapshot Id")]
+    action: Annotated[dict[str, Any], Field(title="Action")]
+    before_observation: Annotated[dict[str, Any], Field(title="Before Observation")]
+    after_observation: Annotated[dict[str, Any] | None, Field(title="After Observation")]
+    source_url: Annotated[str | None, Field(title="Source Url")]
+    error: Annotated[str | None, Field(title="Error")]
+    created_at: Annotated[str, Field(title="Created At")]
+
+
+class ValidationError(BaseModel):
+    loc: Annotated[list[str | int], Field(title="Location")]
+    msg: Annotated[str, Field(title="Message")]
+    type: Annotated[str, Field(title="Error Type")]
+    input: Annotated[Any | None, Field(title="Input")] = None
+    ctx: Annotated[dict[str, Any] | None, Field(title="Context")] = None
+
+
+class CredentialListResponse(BaseModel):
+    credentials: Annotated[list[CredentialMetadata], Field(title="Credentials")]
+
+
+class HTTPValidationError(BaseModel):
+    detail: Annotated[list[ValidationError] | None, Field(title="Detail")] = None
+
+
+class RunCreateRequest(BaseModel):
+    """
+    A goal and the fixed policy for one agent run.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    goal: Annotated[str, Field(max_length=4000, min_length=1, title="Goal")]
+    start_url: Annotated[str, Field(max_length=2048, min_length=1, title="Start Url")]
+    profile: Annotated[str | None, Field(max_length=64, min_length=1, title="Profile")] = "agent"
+    provider: Annotated[Literal["local", "anthropic"] | None, Field(title="Provider")] = "local"
+    model: Annotated[Model | None, Field(title="Model")] = None
+    credential_aliases: Annotated[
+        list[str] | None, Field(max_length=10, title="Credential Aliases")
+    ] = None
+    allowed_origins: Annotated[list[str] | None, Field(max_length=20, title="Allowed Origins")] = (
+        None
+    )
+    limits: RunLimits | None = None
+
+
+class RunListResponse(BaseModel):
+    runs: Annotated[list[RunResponse], Field(title="Runs")]
+    next_cursor: Annotated[str | None, Field(title="Next Cursor")]
+
+
+class SearchResponse(BaseModel):
+    query: Annotated[str, Field(title="Query")]
+    results: Annotated[list[SearchResult], Field(title="Results")]

leashbyte_sdk/client.py

@@ -0,0 +1,345 @@
+"""Synchronous Python client for the stable LeashByte API."""
+
+from __future__ import annotations
+
+import os
+import re
+import time
+from pathlib import Path
+from typing import Any, TypeVar
+from urllib.parse import quote, urlsplit
+
+import httpx
+from pydantic import BaseModel, SecretStr
+
+from ._models import (
+    BrowserActionRequest,
+    BrowserCloseResponse,
+    BrowserSessionRequest,
+    BrowserSessionResponse,
+    BrowserSnapshotResponse,
+    CancelRunRequest,
+    CdpGrantResponse,
+    ConfigResponse,
+    CredentialListResponse,
+    CredentialMetadata,
+    CredentialRequest,
+    FetchRequest,
+    FetchResponse,
+    RunCreateRequest,
+    RunListResponse,
+    RunResponse,
+    SearchResponse,
+    StepResponse,
+)
+
+ModelT = TypeVar("ModelT", bound=BaseModel)
+TERMINAL_RUN_STATES = frozenset({"succeeded", "failed", "cancelled", "limit_reached"})
+_BEARER = re.compile(r"(?i)(bearer\s+)[^\s,;]+")
+
+
+def _secret_value(value: Any) -> Any:
+    if isinstance(value, SecretStr):
+        return value.get_secret_value()
+    if isinstance(value, dict):
+        return {key: _secret_value(item) for key, item in value.items()}
+    if isinstance(value, list):
+        return [_secret_value(item) for item in value]
+    return value
+
+
+class LeashByteError(Exception):
+    """A safe error that never contains a configured key."""
+
+
+class ApiError(LeashByteError):
+    """An error response from the API."""
+
+    def __init__(self, status: int, code: str, message: str, request_id: str | None = None) -> None:
+        super().__init__(message)
+        self.status = status
+        self.code = code
+        self.request_id = request_id
+
+
+class LeashByteClient:
+    """Call the REST API with an API key from an argument or the environment."""
+
+    def __init__(
+        self,
+        base_url: str = "http://127.0.0.1:8080",
+        api_key: str | None = None,
+        *,
+        timeout_seconds: float = 30,
+        transport: httpx.BaseTransport | None = None,
+    ) -> None:
+        parsed = urlsplit(base_url)
+        if parsed.scheme not in {"http", "https"} or not parsed.hostname:
+            raise ValueError("The base URL must use HTTP or HTTPS and include a host.")
+        if parsed.username or parsed.password or parsed.query or parsed.fragment:
+            raise ValueError("The base URL cannot contain credentials, a query or a fragment.")
+        key_file = os.environ.get("LEASHBYTE_API_KEY_FILE")
+        if api_key is None and key_file:
+            api_key = Path(key_file).read_text(encoding="utf-8").strip()
+        api_key = api_key or os.environ.get("LEASHBYTE_API_KEY")
+        if not api_key:
+            raise ValueError("Set api_key, LEASHBYTE_API_KEY or LEASHBYTE_API_KEY_FILE.")
+        self.base_url = base_url.rstrip("/")
+        secret_key = SecretStr(api_key)
+        del api_key
+        self._api_key = secret_key
+        self._client = httpx.Client(
+            base_url=self.base_url,
+            timeout=timeout_seconds,
+            transport=transport,
+        )
+
+    def __repr__(self) -> str:
+        return f"LeashByteClient(base_url={self.base_url!r}, api_key='[redacted]')"
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> LeashByteClient:
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.close()
+
+    def _safe_text(self, value: str, extra_secrets: tuple[str | SecretStr, ...] = ()) -> str:
+        result = _BEARER.sub(r"\1[redacted]", value)
+        for configured in (self._api_key, *extra_secrets):
+            secret = (
+                configured.get_secret_value() if isinstance(configured, SecretStr) else configured
+            )
+            if secret:
+                result = result.replace(secret, "[redacted]")
+                result = result.replace(quote(secret, safe=""), "[redacted]")
+        return result[:2000]
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        response_type: type[ModelT] | None = None,
+        body: BaseModel | None = None,
+        params: dict[str, Any] | None = None,
+        headers: dict[str, str] | None = None,
+        binary: bool = False,
+        extra_secrets: tuple[str | SecretStr, ...] = (),
+    ) -> ModelT | bytes | None:
+        json_body = _secret_value(body.model_dump(exclude_none=True)) if body else None
+        query = {key: value for key, value in (params or {}).items() if value is not None}
+        failure = None
+        try:
+            response = self._client.request(
+                method,
+                path,
+                json=json_body,
+                params=query,
+                headers={
+                    "X-API-Key": self._api_key.get_secret_value(),
+                    **(headers or {}),
+                },
+            )
+            response.request.headers.pop("X-API-Key", None)
+            response.request.headers.pop("X-CDP-Key", None)
+        except httpx.HTTPError as error:
+            failure = type(error).__name__
+        finally:
+            del json_body, headers
+        if failure is not None:
+            message = self._safe_text(f"The API request failed with {failure}.", extra_secrets)
+            raise LeashByteError(message) from None
+        if response.status_code >= 400:
+            status = response.status_code
+            code = "http_error"
+            message = f"The API returned HTTP {status}."
+            request_id = self._safe_text(response.headers.get("X-Request-ID", ""), extra_secrets)
+            payload = None
+            error = None
+            try:
+                payload = response.json()
+                error = payload.get("error", {})
+                code = self._safe_text(str(error.get("code", code)), extra_secrets)
+                message = self._safe_text(str(error.get("message", message)), extra_secrets)
+            except (ValueError, AttributeError):
+                pass
+            finally:
+                del response, payload, error
+            raise ApiError(status, code, message, request_id or None)
+        if binary:
+            return response.content
+        if response.status_code == 204:
+            return None
+        payload = None
+        try:
+            payload = response.json()
+            return response_type.model_validate(payload) if response_type else payload
+        except (ValueError, TypeError) as error:
+            error_type = type(error).__name__
+            del response, payload
+            raise LeashByteError(
+                self._safe_text(
+                    f"The API returned an invalid response with {error_type}.",
+                    extra_secrets,
+                )
+            ) from None
+
+    @staticmethod
+    def _segment(value: str) -> str:
+        if value in {"", ".", ".."}:
+            raise ValueError("An identifier cannot be empty or a relative path segment.")
+        return quote(value, safe="")
+
+    def health(self) -> dict[str, str]:
+        return self._request("GET", "/healthz")
+
+    def ready(self) -> dict[str, str]:
+        return self._request("GET", "/readyz")
+
+    def get_config(self) -> ConfigResponse:
+        return self._request("GET", "/v1/config", response_type=ConfigResponse)
+
+    def search(
+        self, query: str, *, limit: int = 10, language: str = "en", safe_search: int = 1
+    ) -> SearchResponse:
+        return self._request(
+            "GET",
+            "/v1/search",
+            params={"q": query, "limit": limit, "language": language, "safe_search": safe_search},
+            response_type=SearchResponse,
+        )
+
+    def fetch(self, request: FetchRequest) -> FetchResponse:
+        return self._request("POST", "/v1/fetch", body=request, response_type=FetchResponse)
+
+    def create_browser_session(self, request: BrowserSessionRequest) -> BrowserSessionResponse:
+        return self._request(
+            "POST", "/v1/browser/sessions", body=request, response_type=BrowserSessionResponse
+        )
+
+    def get_browser_session(self, session_id: str) -> BrowserSessionResponse:
+        return self._request(
+            "GET",
+            f"/v1/browser/sessions/{self._segment(session_id)}",
+            response_type=BrowserSessionResponse,
+        )
+
+    def close_browser_session(self, session_id: str) -> BrowserCloseResponse:
+        return self._request(
+            "DELETE",
+            f"/v1/browser/sessions/{self._segment(session_id)}",
+            response_type=BrowserCloseResponse,
+        )
+
+    def browser_snapshot(self, session_id: str) -> BrowserSnapshotResponse:
+        return self._request(
+            "GET",
+            f"/v1/browser/sessions/{self._segment(session_id)}/snapshot",
+            response_type=BrowserSnapshotResponse,
+        )
+
+    def browser_action(
+        self, session_id: str, request: BrowserActionRequest
+    ) -> BrowserSnapshotResponse:
+        return self._request(
+            "POST",
+            f"/v1/browser/sessions/{self._segment(session_id)}/actions",
+            body=request,
+            response_type=BrowserSnapshotResponse,
+        )
+
+    def browser_screenshot(self, session_id: str) -> bytes:
+        return self._request(
+            "GET", f"/v1/browser/sessions/{self._segment(session_id)}/screenshot", binary=True
+        )
+
+    def cdp_grant(self, session_id: str, cdp_key: str) -> CdpGrantResponse:
+        secret = SecretStr(cdp_key)
+        del cdp_key
+        return self._request(
+            "GET",
+            f"/v1/browser/sessions/{self._segment(session_id)}/cdp",
+            headers={"X-CDP-Key": secret.get_secret_value()},
+            response_type=CdpGrantResponse,
+            extra_secrets=(secret,),
+        )
+
+    def create_credential(self, request: CredentialRequest) -> CredentialMetadata:
+        return self._request(
+            "POST", "/v1/vault/credentials", body=request, response_type=CredentialMetadata
+        )
+
+    def list_credentials(self) -> CredentialListResponse:
+        return self._request("GET", "/v1/vault/credentials", response_type=CredentialListResponse)
+
+    def replace_credential(self, request: CredentialRequest) -> CredentialMetadata:
+        return self._request(
+            "PUT",
+            f"/v1/vault/credentials/{self._segment(request.alias)}",
+            body=request,
+            response_type=CredentialMetadata,
+        )
+
+    def delete_credential(self, alias: str) -> None:
+        self._request("DELETE", f"/v1/vault/credentials/{self._segment(alias)}")
+
+    def create_run(self, request: RunCreateRequest) -> RunResponse:
+        return self._request("POST", "/v1/runs", body=request, response_type=RunResponse)
+
+    def list_runs(self, *, limit: int = 50, cursor: str | None = None) -> RunListResponse:
+        return self._request(
+            "GET",
+            "/v1/runs",
+            params={"limit": limit, "cursor": cursor},
+            response_type=RunListResponse,
+        )
+
+    def get_run(self, run_id: str) -> RunResponse:
+        return self._request("GET", f"/v1/runs/{self._segment(run_id)}", response_type=RunResponse)
+
+    def get_run_steps(self, run_id: str) -> list[StepResponse]:
+        path = f"/v1/runs/{self._segment(run_id)}/steps"
+        payload = self._request("GET", path)
+        if not isinstance(payload, list):
+            raise LeashByteError("The API returned an invalid run steps response.")
+        try:
+            return [StepResponse.model_validate(item) for item in payload]
+        except (ValueError, TypeError) as error:
+            raise LeashByteError(
+                f"The API returned invalid run steps with {type(error).__name__}."
+            ) from None
+
+    def run_artifact(self, run_id: str, name: str) -> bytes:
+        return self._request(
+            "GET",
+            f"/v1/runs/{self._segment(run_id)}/artifacts/{self._segment(name)}",
+            binary=True,
+        )
+
+    def cancel_run(self, run_id: str, reason: str = "Cancelled by the user.") -> RunResponse:
+        return self._request(
+            "POST",
+            f"/v1/runs/{self._segment(run_id)}/cancel",
+            body=CancelRunRequest(reason=reason),
+            response_type=RunResponse,
+        )
+
+    def delete_run(self, run_id: str) -> None:
+        self._request("DELETE", f"/v1/runs/{self._segment(run_id)}")
+
+    def wait_for_run(
+        self, run_id: str, *, timeout_seconds: float = 600, interval_seconds: float = 1
+    ) -> RunResponse:
+        if timeout_seconds <= 0 or interval_seconds <= 0:
+            raise ValueError("The polling timeout and interval must be greater than zero.")
+        deadline = time.monotonic() + timeout_seconds
+        while True:
+            run = self.get_run(run_id)
+            if run.state in TERMINAL_RUN_STATES:
+                return run
+            if time.monotonic() >= deadline:
+                raise LeashByteError("The run did not finish before the polling timeout.")
+            time.sleep(min(interval_seconds, max(0, deadline - time.monotonic())))

leashbyte_sdk-0.1.1.dist-info/METADATA

@@ -0,0 +1,52 @@
+Metadata-Version: 2.5
+Name: leashbyte-sdk
+Version: 0.1.1
+Summary: Python client for the LeashByte API
+Project-URL: Homepage, https://leashbyte.com
+Project-URL: Repository, https://github.com/mangybyte/leashbyte
+Project-URL: Issues, https://github.com/mangybyte/leashbyte/issues
+Project-URL: Changelog, https://github.com/mangybyte/leashbyte/blob/main/CHANGELOG.md
+Author: MangyByte Ltd
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: <3.14,>=3.13
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: pydantic<3,>=2.11
+Description-Content-Type: text/markdown
+
+# LeashByte Python SDK
+
+A Python client for the stable LeashByte REST API. The models are generated from `openapi.json`, and a hand-written client on top adds authentication, binary downloads and run polling. It needs Python 3.13.
+
+Install it from PyPI:
+
+```bash
+pip install leashbyte-sdk
+```
+
+With uv, use `uv add leashbyte-sdk`. From a checkout of the repository, `uv pip install ./sdk/python` installs the copy in your tree.
+
+```python
+import os
+
+from leashbyte_sdk import FetchRequest, LeashByteClient, RunCreateRequest
+
+with LeashByteClient(api_key=os.environ["LEASHBYTE_API_KEY"]) as client:
+    page = client.fetch(FetchRequest(url="https://example.com"))
+    results = client.search("self-hosted web automation", limit=3)
+    run = client.create_run(
+        RunCreateRequest(
+            goal="Read the page title. Return it as the result.",
+            start_url="https://example.com",
+        )
+    )
+    finished = client.wait_for_run(run.id)
+    print(page.content)
+    print(results.results)
+    print(finished.state)
+```
+
+You can leave out `api_key` and set `LEASHBYTE_API_KEY` or `LEASHBYTE_API_KEY_FILE` instead, which keeps the key out of your code. The default base URL is `http://127.0.0.1:8080`.
+
+The client never logs keys, and its `repr` and API errors redact the configured one. Run artifacts and screenshots can contain page data, so keep them in private storage. For browser logins, use credential placeholders. Passwords don't belong in goals, URLs or ordinary text actions.

leashbyte_sdk-0.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+leashbyte_sdk/__init__.py,sha256=kP4Hhr1C-VU2OKy3zB2_xRO_MdFOaj2XdaMEv0-6IWw,1235
+leashbyte_sdk/_models.py,sha256=4wkEja0rSBLXwiE-LjvVFdDxQFFUAPsnmsFDO20oTHo,9836
+leashbyte_sdk/client.py,sha256=K93bYAdCI_IhuZe3RvYuQHbh9lPu-Cd57Kwdy_ym4JY,12878
+leashbyte_sdk-0.1.1.dist-info/METADATA,sha256=U2d_vt5jTyPKgVDWudknTDzjwOnEoG2D41UyL8fM_JA,2096
+leashbyte_sdk-0.1.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+leashbyte_sdk-0.1.1.dist-info/licenses/LICENSE,sha256=vwNrEYRM8MZFqsqq2LhiQSj6822dhf-0SmMCSRCSDZc,11387
+leashbyte_sdk-0.1.1.dist-info/licenses/NOTICE,sha256=MZAh6t_p5xC0de_MbU8cExuPceXxl0RMca7hz65iAbU,273
+leashbyte_sdk-0.1.1.dist-info/RECORD,,

leashbyte_sdk-0.1.1.dist-info/WHEEL

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

leashbyte_sdk-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 MangyByte Ltd
+
+                                 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 reasonable and customary use in 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 failure or malfunction, 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 Additional Liability. 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 additional liability.
+
+   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 [yyyy] [name of copyright owner]
+
+   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.

leashbyte_sdk-0.1.1.dist-info/licenses/NOTICE

@@ -0,0 +1,6 @@
+LeashByte Python SDK
+Copyright 2026 MangyByte Ltd
+
+This package uses HTTPX under BSD-3-Clause and Pydantic under MIT.
+Those packages retain their licence files in their installed dist-info directories.
+Neither locked dependency distribution contains a NOTICE file to copy.