browserwhale 0.1.0b1__py3-none-any.whl

browserwhale/__init__.py

@@ -0,0 +1,109 @@
+"""Python client for the hosted Browserwhale API.
+
+>>> from browserwhale import Whale
+>>> task = Whale().run(url="https://example.com", goal="Find the page's main heading.")
+"""
+
+from ._client import (
+    Response,
+    ServerSentEvent,
+    StreamResponse,
+    StreamTransport,
+    Tasks,
+    Transport,
+    Whale,
+    urllib_stream_transport,
+    urllib_transport,
+)
+from ._errors import (
+    APIConnectionError,
+    ApiError,
+    AuthenticationError,
+    ConflictError,
+    InternalServerError,
+    InvalidRequestError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+    TaskFailedError,
+    WaitTimeoutError,
+    WhaleError,
+)
+from ._types import (
+    CreateTaskParams,
+    JsonSchema,
+    JsonValue,
+    ModelProvider,
+    SkillId,
+    StoredDataMode,
+    StepEvent,
+    StatusEvent,
+    DoneEvent,
+    Task,
+    TaskEvent,
+    TaskCause,
+    TaskChangeEvidence,
+    TaskConfirmation,
+    TaskEvidence,
+    TaskLimitation,
+    TaskLimits,
+    TaskList,
+    TaskModel,
+    TaskResult,
+    TaskStatus,
+    TaskStep,
+    TaskUsage,
+    TaskValueEvidence,
+    Usage,
+)
+
+__version__ = "0.1.0b1"
+
+__all__ = [
+    "Whale",
+    "Tasks",
+    "Transport",
+    "Response",
+    "urllib_transport",
+    "StreamTransport",
+    "StreamResponse",
+    "ServerSentEvent",
+    "urllib_stream_transport",
+    "WhaleError",
+    "ApiError",
+    "InvalidRequestError",
+    "AuthenticationError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "ConflictError",
+    "RateLimitError",
+    "InternalServerError",
+    "APIConnectionError",
+    "TaskFailedError",
+    "WaitTimeoutError",
+    "Task",
+    "TaskStatus",
+    "TaskCause",
+    "TaskConfirmation",
+    "TaskEvidence",
+    "TaskValueEvidence",
+    "TaskChangeEvidence",
+    "TaskResult",
+    "TaskLimitation",
+    "TaskStep",
+    "TaskEvent",
+    "StepEvent",
+    "StatusEvent",
+    "DoneEvent",
+    "SkillId",
+    "StoredDataMode",
+    "TaskUsage",
+    "Usage",
+    "TaskLimits",
+    "TaskList",
+    "CreateTaskParams",
+    "TaskModel",
+    "ModelProvider",
+    "JsonSchema",
+    "JsonValue",
+]

browserwhale/_client.py

@@ -0,0 +1,457 @@
+from __future__ import annotations
+
+import json
+import os
+import random
+import time
+import urllib.error
+import urllib.parse
+import urllib.request
+import uuid
+from dataclasses import dataclass
+from typing import Any, Callable, Dict, Iterable, Iterator, List, Mapping, Optional, Union, cast
+
+from ._errors import (
+    APIConnectionError,
+    ApiError,
+    RateLimitError,
+    TaskFailedError,
+    WaitTimeoutError,
+    WhaleError,
+    error_from_response,
+)
+from ._types import (
+    ACTIVE_STATUSES,
+    CreateTaskParams,
+    JsonSchema,
+    JsonValue,
+    SkillId,
+    StoredDataMode,
+    Task,
+    TaskEvent,
+    TaskLimits,
+    TaskList,
+    TaskModel,
+    TaskStep,
+    Usage,
+)
+
+MAX_WAIT_SECONDS = 30
+
+
+@dataclass
+class Response:
+    status: int
+    #: Lower-case header names.
+    headers: Dict[str, str]
+    body: bytes
+
+
+#: Sends one request: ``(method, url, headers, body, timeout_seconds) -> Response``.
+#: Raises ``OSError`` (or a subclass) when no response arrives.
+Transport = Callable[[str, str, Dict[str, str], Optional[bytes], float], Response]
+
+
+def urllib_transport(
+    method: str, url: str, headers: Dict[str, str], body: Optional[bytes], timeout: float
+) -> Response:
+    """The default transport: the standard library's ``urllib``, no dependencies."""
+    request = urllib.request.Request(url, data=body, headers=headers, method=method)
+    try:
+        with urllib.request.urlopen(request, timeout=timeout) as reply:
+            return Response(
+                reply.status, {k.lower(): v for k, v in reply.headers.items()}, reply.read()
+            )
+    except urllib.error.HTTPError as error:
+        return Response(
+            error.code, {k.lower(): v for k, v in error.headers.items()}, error.read()
+        )
+
+
+@dataclass
+class StreamResponse:
+    """An open response whose body is read line by line (``text/event-stream``)."""
+
+    status: int
+    #: Lower-case header names.
+    headers: Dict[str, str]
+    #: The body's lines, line ends included; reading may raise ``OSError``.
+    lines: Iterable[bytes]
+    close: Callable[[], None]
+
+
+#: Opens one streaming GET: ``(url, headers, timeout_seconds) -> StreamResponse``, where
+#: the timeout applies to each read. Raises ``OSError`` (or a subclass) when no response arrives.
+StreamTransport = Callable[[str, Dict[str, str], float], StreamResponse]
+
+
+def urllib_stream_transport(url: str, headers: Dict[str, str], timeout: float) -> StreamResponse:
+    """The default stream transport: the standard library's ``urllib``."""
+    request = urllib.request.Request(url, headers=headers, method="GET")
+    try:
+        reply = urllib.request.urlopen(request, timeout=timeout)
+    except urllib.error.HTTPError as error:
+        body = error.read()
+        error.close()
+        return StreamResponse(
+            error.code, {k.lower(): v for k, v in error.headers.items()}, [body], lambda: None
+        )
+    return StreamResponse(
+        reply.status, {k.lower(): v for k, v in reply.headers.items()}, iter(reply.readline, b""),
+        reply.close,
+    )
+
+
+@dataclass
+class ServerSentEvent:
+    event: str
+    data: str
+    id: Optional[str] = None
+    retry: Optional[int] = None
+
+
+def parse_event_stream(lines: Iterable[bytes]) -> Iterator[ServerSentEvent]:
+    """Parses ``text/event-stream`` lines into events (``event``, ``data``, ``id``, ``retry``, comments)."""
+    event: Optional[str] = None
+    data: List[str] = []
+    event_id: Optional[str] = None
+    retry: Optional[int] = None
+    for raw in lines:
+        for line in raw.decode("utf-8").splitlines() or [""]:
+            if line == "":
+                if data or retry is not None:
+                    yield ServerSentEvent(
+                        event or "message" if data else "", "\n".join(data), event_id, retry
+                    )
+                event, data, event_id, retry = None, [], None, None
+                continue
+            if line.startswith(":"):
+                continue
+            field, _, value = line.partition(":")
+            if value.startswith(" "):
+                value = value[1:]
+            if field == "event":
+                event = value
+            elif field == "data":
+                data.append(value)
+            elif field == "id" and "\0" not in value:
+                event_id = value
+            elif field == "retry" and value.isdigit():
+                retry = int(value)
+
+
+def _retryable(error: ApiError) -> bool:
+    return error.status == 429 or error.status >= 500
+
+
+def _backoff(attempt: int) -> float:
+    return min(8.0, 0.5 * 2**attempt) * (0.5 + random.random() / 2)
+
+
+class Whale:
+    """Client for the hosted Browserwhale API.
+
+    ``api_key`` and ``base_url`` default to ``BROWSERWHALE_API_KEY`` and
+    ``BROWSERWHALE_BASE_URL``. Requests after a 429, a 5xx or a network
+    failure are retried ``max_retries`` times, reusing the same
+    ``Idempotency-Key``. ``timeout`` is per request, excluding long-poll waits.
+    """
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        base_url: Optional[str] = None,
+        *,
+        max_retries: int = 2,
+        timeout: float = 60.0,
+        transport: Optional[Transport] = None,
+        stream_transport: Optional[StreamTransport] = None,
+        sleep: Callable[[float], None] = time.sleep,
+    ) -> None:
+        api_key = api_key or os.environ.get("BROWSERWHALE_API_KEY")
+        base_url = base_url or os.environ.get("BROWSERWHALE_BASE_URL")
+        if not api_key:
+            raise WhaleError("Missing api_key (or BROWSERWHALE_API_KEY).")
+        if not base_url:
+            raise WhaleError("Missing base_url (or BROWSERWHALE_BASE_URL).")
+        self._api_key = api_key
+        self._base_url = base_url.rstrip("/")
+        self._max_retries = max_retries
+        self._timeout = timeout
+        self._transport = transport or urllib_transport
+        self._stream_transport = stream_transport or urllib_stream_transport
+        self._sleep = sleep
+        self.tasks = Tasks(self)
+
+    def usage(self, *, month: Optional[str] = None) -> Usage:
+        """This key's usage and cost for a calendar month (``YYYY-MM``, UTC); the current month by default."""
+        return cast(Usage, self._request("GET", "/v1/usage", query={"month": month}))
+
+    def run(
+        self,
+        url: Optional[str],
+        goal: str,
+        *,
+        session_id: Optional[str] = None,
+        output_schema: Optional[JsonSchema] = None,
+        variables: Optional[Dict[str, JsonValue]] = None,
+        limits: Optional[TaskLimits] = None,
+        metadata: Optional[Dict[str, JsonValue]] = None,
+        webhook_url: Optional[str] = None,
+        notes: Optional[str] = None,
+        skills: Union[str, List[SkillId], None] = None,
+        cache: Optional[StoredDataMode] = None,
+        site_context: Optional[StoredDataMode] = None,
+        vision: Optional[str] = None,
+        model: Optional[TaskModel] = None,
+        on_progress: Optional[Callable[[TaskStep], None]] = None,
+        idempotency_key: Optional[str] = None,
+        timeout: float = 15 * 60,
+    ) -> Task:
+        """Creates a task and waits until it finishes.
+
+        Returns the task when it is ``completed``; raises ``TaskFailedError``
+        (carrying the task) for any other final status and
+        ``WaitTimeoutError`` after ``timeout`` seconds. With ``session_id`` the
+        task runs in that open session, and ``url`` may be ``None`` to continue
+        on the page the previous task ended on. ``notes``, ``skills``,
+        ``cache``, ``site_context`` and ``vision`` are the opt-in features, off
+        by default. ``model`` runs the task with your own model provider key,
+        which the service never stores. With ``on_progress`` the client follows the task's live
+        events and calls it with each new step; otherwise it long-polls.
+        Interrupting it (``KeyboardInterrupt``) cancels the task; ``timeout``
+        only stops waiting.
+        """
+        params: CreateTaskParams = {"goal": goal}
+        if url is not None:
+            params["url"] = url
+        if session_id is not None:
+            params["session_id"] = session_id
+        if output_schema is not None:
+            params["output_schema"] = output_schema
+        if variables is not None:
+            params["variables"] = variables
+        if limits is not None:
+            params["limits"] = limits
+        if metadata is not None:
+            params["metadata"] = metadata
+        if webhook_url is not None:
+            params["webhook_url"] = webhook_url
+        if notes is not None:
+            params["notes"] = notes
+        if skills is not None:
+            params["skills"] = cast(Any, skills)
+        if cache is not None:
+            params["cache"] = cache
+        if site_context is not None:
+            params["site_context"] = site_context
+        if vision is not None:
+            params["vision"] = cast(Any, vision)
+        if model is not None:
+            params["model"] = model
+        deadline = time.monotonic() + timeout
+        task = self.tasks.create(params, idempotency_key=idempotency_key)
+        try:
+            if on_progress is not None and task["status"] in ACTIVE_STATUSES:
+                for event in self.tasks._events(task["id"], None, deadline):
+                    if event["type"] == "step":
+                        on_progress(event["step"])
+                    elif event["type"] == "done":
+                        task = event["task"]
+            while task["status"] in ACTIVE_STATUSES:
+                remaining = deadline - time.monotonic()
+                if remaining <= 0:
+                    raise WaitTimeoutError(task["id"], timeout)
+                task = self.tasks.get(
+                    task["id"], wait=min(MAX_WAIT_SECONDS, max(1, int(remaining))))
+        except KeyboardInterrupt:
+            # The caller gave up on the task, so it should not keep running (and costing).
+            try:
+                self.tasks.cancel(task["id"])
+            except Exception:  # noqa: BLE001 - the interrupt is what the caller sees
+                pass
+            raise
+        if task["status"] != "completed":
+            raise TaskFailedError(task)
+        return task
+
+    def _open_stream(self, path: str, last_event_id: Optional[str]) -> StreamResponse:
+        """Opens an event stream, retrying like ``_request`` until the response starts."""
+        headers = {
+            "Authorization": f"Bearer {self._api_key}",
+            "Accept": "text/event-stream",
+            "User-Agent": "browserwhale-python/0.1.0b1",
+        }
+        if last_event_id:
+            headers["Last-Event-ID"] = last_event_id
+        attempt = 0
+        while True:
+            try:
+                response = self._stream_transport(self._base_url + path, headers, self._timeout)
+            except OSError as error:
+                if attempt < self._max_retries:
+                    self._sleep(_backoff(attempt))
+                    attempt += 1
+                    continue
+                raise APIConnectionError(f"Request failed: GET {path}") from error
+            if 200 <= response.status < 300:
+                return response
+            try:
+                body = b"".join(response.lines)
+                parsed = json.loads(body) if body else None
+            except (ValueError, OSError):
+                parsed = None
+            finally:
+                response.close()
+            error = error_from_response(response.status, parsed, response.headers)
+            if _retryable(error) and attempt < self._max_retries:
+                retry_after = error.retry_after if isinstance(error, RateLimitError) else None
+                self._sleep(min(retry_after, 60) if retry_after is not None else _backoff(attempt))
+                attempt += 1
+                continue
+            raise error
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        query: Optional[Mapping[str, Any]] = None,
+        body: Any = None,
+        idempotency_key: Optional[str] = None,
+        extra_timeout: float = 0,
+    ) -> Any:
+        url = self._base_url + path
+        params = {k: v for k, v in (query or {}).items() if v is not None}
+        if params:
+            url += "?" + urllib.parse.urlencode(params)
+        headers = {
+            "Authorization": f"Bearer {self._api_key}",
+            "Accept": "application/json",
+            "User-Agent": "browserwhale-python/0.1.0b1",
+        }
+        data = None
+        if body is not None:
+            headers["Content-Type"] = "application/json"
+            data = json.dumps(body).encode()
+        if idempotency_key:
+            headers["Idempotency-Key"] = idempotency_key
+        attempt = 0
+        while True:
+            try:
+                response = self._transport(
+                    method, url, headers, data, self._timeout + extra_timeout
+                )
+            except OSError as error:
+                if attempt < self._max_retries:
+                    self._sleep(_backoff(attempt))
+                    attempt += 1
+                    continue
+                raise APIConnectionError(f"Request failed: {method} {path}") from error
+            try:
+                parsed = json.loads(response.body) if response.body else None
+            except ValueError:
+                parsed = None
+            if 200 <= response.status < 300:
+                return parsed
+            error = error_from_response(response.status, parsed, response.headers)
+            if _retryable(error) and attempt < self._max_retries:
+                retry_after = error.retry_after if isinstance(error, RateLimitError) else None
+                self._sleep(min(retry_after, 60) if retry_after is not None else _backoff(attempt))
+                attempt += 1
+                continue
+            raise error
+
+
+class Tasks:
+    """Lower-level task operations, one per endpoint."""
+
+    def __init__(self, client: Whale) -> None:
+        self._client = client
+
+    def create(self, params: CreateTaskParams, *, idempotency_key: Optional[str] = None) -> Task:
+        """Always sends an ``Idempotency-Key``, so automatic retries cannot create duplicates."""
+        return cast(
+            Task,
+            self._client._request(
+                "POST",
+                "/v1/tasks",
+                body=params,
+                idempotency_key=idempotency_key or str(uuid.uuid4()),
+            ),
+        )
+
+    def get(self, task_id: str, *, wait: Optional[float] = None) -> Task:
+        """With ``wait`` (seconds, max 30) the server holds the request until the task finishes."""
+        return cast(
+            Task,
+            self._client._request(
+                "GET",
+                f"/v1/tasks/{urllib.parse.quote(task_id, safe='')}",
+                query={"wait": wait},
+                extra_timeout=wait or 0,
+            ),
+        )
+
+    def events(self, task_id: str, *, last_event_id: Optional[str] = None) -> Iterator[TaskEvent]:
+        """The task's live events: each new ``step``, each ``status`` change, then
+        ``done`` with the finished task, after which the iterator ends.
+
+        Each stream lasts under a minute; the iterator reconnects on its own and
+        resumes after the last step it saw (``Last-Event-ID``). A connection that
+        drops more than ``max_retries`` times in a row raises ``APIConnectionError``.
+        """
+        return self._events(task_id, last_event_id, None)
+
+    def _events(
+        self, task_id: str, last_event_id: Optional[str], deadline: Optional[float]
+    ) -> Iterator[TaskEvent]:
+        client = self._client
+        path = f"/v1/tasks/{urllib.parse.quote(task_id, safe='')}/events"
+        reconnect = 1.0
+        failures = 0
+        while True:
+            response = client._open_stream(path, last_event_id)
+            try:
+                for event in parse_event_stream(response.lines):
+                    if event.retry is not None:
+                        reconnect = event.retry / 1000
+                    if event.id is not None:
+                        last_event_id = event.id
+                    if not event.data:
+                        continue
+                    failures = 0
+                    data = json.loads(event.data)
+                    if event.event == "step":
+                        yield {"type": "step", "step": data}
+                    elif event.event == "status":
+                        yield {"type": "status", "status": data["status"]}
+                    elif event.event == "done":
+                        yield {"type": "done", "task": data}
+                        return
+            except OSError as error:
+                # A dropped connection: reconnect below, unless it keeps failing.
+                failures += 1
+                if failures > client._max_retries:
+                    raise APIConnectionError(f"Event stream failed: task {task_id}") from error
+            finally:
+                response.close()
+            if deadline is not None and time.monotonic() >= deadline:
+                return
+            client._sleep(reconnect)
+
+    def list(self, *, limit: Optional[int] = None, cursor: Optional[str] = None) -> TaskList:
+        """Newest first. Pass ``next_cursor`` from the previous page as ``cursor``."""
+        return cast(
+            TaskList,
+            self._client._request("GET", "/v1/tasks", query={"limit": limit, "cursor": cursor}),
+        )
+
+    def cancel(self, task_id: str) -> Task:
+        """Idempotent: cancelling a finished task returns it unchanged."""
+        return cast(
+            Task,
+            self._client._request(
+                "POST", f"/v1/tasks/{urllib.parse.quote(task_id, safe='')}/cancel"
+            ),
+        )

browserwhale/_errors.py

@@ -0,0 +1,129 @@
+from __future__ import annotations
+
+from typing import Any, Mapping, Optional
+
+from ._types import Task
+
+
+class WhaleError(Exception):
+    """Base class for every error the client raises."""
+
+
+class ApiError(WhaleError):
+    """The API answered with an error object."""
+
+    def __init__(
+        self,
+        status: int,
+        type: str,
+        message: str,
+        param: Optional[str] = None,
+        request_id: Optional[str] = None,
+    ) -> None:
+        super().__init__(message)
+        self.status = status
+        self.type = type
+        self.message = message
+        self.param = param
+        self.request_id = request_id
+
+
+class InvalidRequestError(ApiError):
+    pass
+
+
+class AuthenticationError(ApiError):
+    pass
+
+
+class PermissionDeniedError(ApiError):
+    pass
+
+
+class NotFoundError(ApiError):
+    pass
+
+
+class ConflictError(ApiError):
+    """For example, an ``Idempotency-Key`` reused with a different body."""
+
+
+class RateLimitError(ApiError):
+    """HTTP 429. ``retry_after`` is in seconds; ``code`` says which limit was reached."""
+
+    def __init__(
+        self,
+        status: int,
+        message: str,
+        retry_after: Optional[float],
+        request_id: Optional[str] = None,
+        code: Optional[str] = None,
+    ) -> None:
+        super().__init__(status, "rate_limited", message, None, request_id)
+        self.retry_after = retry_after
+        #: ``rate_limit_exceeded`` or ``concurrency_limit_exceeded``; None from older servers.
+        self.code = code
+
+
+class InternalServerError(ApiError):
+    pass
+
+
+class APIConnectionError(WhaleError):
+    """The request never produced an HTTP response (network failure or request timeout)."""
+
+
+class TaskFailedError(WhaleError):
+    """The task finished without completing; ``task`` keeps its partial results and limitations."""
+
+    def __init__(self, task: Task) -> None:
+        reasons = " ".join(item["reason"] for item in task["limitations"])
+        cause = f" ({task['cause']})" if task.get("cause") else ""
+        super().__init__(
+            f"Task {task['id']} ended {task['status']}{cause}: {reasons or 'no completed result.'}"
+        )
+        self.task = task
+
+
+class WaitTimeoutError(WhaleError):
+    """``run()`` stopped waiting; the task may still be running on the server."""
+
+    def __init__(self, task_id: Optional[str], timeout: float) -> None:
+        suffix = f" for task {task_id}; it may still be running" if task_id else ""
+        super().__init__(f"Gave up waiting after {timeout:g} s{suffix}.")
+        self.task_id = task_id
+
+
+_BY_TYPE = {
+    "invalid_request": InvalidRequestError,
+    "authentication": AuthenticationError,
+    "permission": PermissionDeniedError,
+    "not_found": NotFoundError,
+    "conflict": ConflictError,
+}
+
+
+def error_from_response(status: int, body: Any, headers: Mapping[str, str]) -> ApiError:
+    error = body.get("error") if isinstance(body, dict) else None
+    error = error if isinstance(error, dict) else {}
+    message = error.get("message") or f"HTTP {status}"
+    request_id = headers.get("request-id")
+    kind = error.get("type") or ("internal" if status >= 500 else "invalid_request")
+    if kind == "rate_limited":
+        raw = headers.get("retry-after")
+        try:
+            retry_after: Optional[float] = float(raw) if raw is not None else None
+        except ValueError:
+            retry_after = None
+        code = error.get("code")
+        return RateLimitError(
+            status,
+            message,
+            retry_after,
+            request_id,
+            code if code in ("rate_limit_exceeded", "concurrency_limit_exceeded") else None,
+        )
+    cls = _BY_TYPE.get(kind)
+    if cls is None:
+        return InternalServerError(status, "internal", message, error.get("param"), request_id)
+    return cls(status, kind, message, error.get("param"), request_id)

browserwhale/_types.py

@@ -0,0 +1,244 @@
+"""Field names match the HTTP API (snake_case); see ``api/openapi.json``."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, List, Literal, Optional, TypedDict, Union
+
+TaskStatus = Literal["queued", "running", "completed", "partial", "failed", "cancelled"]
+TaskCause = Literal[
+    "site_blocked",
+    "unavailable",
+    "limit_reached",
+    "could_not_complete",
+    "needs_confirmation",
+    "cancelled",
+    "internal_error",
+]
+JsonValue = Union[str, int, float, bool, None, List[Any], Dict[str, Any]]
+JsonSchema = Dict[str, Any]
+
+# The statuses a task can still leave. Anything else is final, so a status added
+# to the API after this client was published stops the wait instead of polling.
+ACTIVE_STATUSES = frozenset({"queued", "running"})
+
+
+class TaskResult(TypedDict):
+    """One part of the request: its goal, whether it was done, and its data."""
+
+    goal: str
+    status: Literal["completed", "incomplete"]
+    data: JsonValue
+
+
+class TaskLimitation(TypedDict):
+    """A part of the request that was not done, and why, in plain language."""
+
+    requirement: str
+    reason: str
+
+
+class TaskValueEvidence(TypedDict):
+    """Where a value of the output was read."""
+
+    #: Its place in ``output``, such as ``items[0].price``; "" for the whole output.
+    path: str
+    url: str
+    #: The page's text the value was read from.
+    quote: str
+
+
+class _TaskChangeEvidence(TypedDict):
+    action: str
+    url: str
+
+
+class TaskChangeEvidence(_TaskChangeEvidence, total=False):
+    """A change the task made on the site, and the site's HTTP answer when known."""
+
+    status: int
+
+
+TaskEvidence = Union[TaskValueEvidence, TaskChangeEvidence]
+
+
+class TaskConfirmation(TypedDict):
+    """An act the task stopped before, for you to confirm."""
+
+    #: The part of the request it was for.
+    requirement: str
+    #: What was about to happen, such as ``Clicking 'Place order'``.
+    action: str
+    #: What it would do, completing "it would ...", such as ``place an order``.
+    effect: str
+    kind: Literal[
+        "purchase",
+        "payment",
+        "binding",
+        "delete",
+        "account",
+        "subscription",
+        "booking",
+        "application",
+        "message",
+        "submission",
+        "caller_data",
+    ]
+
+
+class TaskStep(TypedDict):
+    """One plain-language step, such as ``Clicking "Sort by price"``."""
+
+    n: int
+    description: str
+
+
+class TaskUsage(TypedDict):
+    steps: int
+    model_calls: int
+    input_tokens: int
+    output_tokens: int
+    duration_ms: int
+    cost_usd: Optional[float]
+
+
+class Task(TypedDict):
+    id: str
+    status: TaskStatus
+    #: Set whenever a finished task is not ``completed``.
+    cause: Optional[TaskCause]
+    #: Present only when ``completed``; valid against the output schema if one was given.
+    output: JsonValue
+    results: List[TaskResult]
+    limitations: List[TaskLimitation]
+    final_url: Optional[str]
+    #: Set when the task stopped before an act that needs your confirmation
+    #: (cause ``needs_confirmation``), such as placing an order.
+    confirmation: Optional[TaskConfirmation]
+    #: Where each value was read, and each change made with the site's answer.
+    evidence: List[TaskEvidence]
+    #: What the agent did, in plain language; grows while the task runs.
+    steps: List[TaskStep]
+    usage: Optional[TaskUsage]
+    created_at: str
+    started_at: Optional[str]
+    finished_at: Optional[str]
+    metadata: Dict[str, JsonValue]
+    #: Where the ``task.finished`` webhook is sent, if set at creation.
+    webhook_url: Optional[str]
+    #: The schedule that created this task, if any.
+    schedule_id: Optional[str]
+    #: The session the task ran in, if any.
+    session_id: Optional[str]
+
+
+class TaskLimits(TypedDict, total=False):
+    timeout_seconds: int
+    max_steps: int
+
+
+#: General know-how the agent can use; see ``CreateTaskParams.skills``.
+SkillId = Literal["shopping", "admin", "forms", "media"]
+#: ``read-only`` uses what earlier tasks saved and never saves.
+StoredDataMode = Literal["read-write", "read-only"]
+
+
+#: The model providers you can bring your own key for.
+ModelProvider = Literal["openai", "openai-compatible", "azure", "anthropic", "google"]
+
+
+class _TaskModelRequired(TypedDict):
+    #: ``openai-compatible`` is any endpoint that speaks the OpenAI Chat Completions API.
+    provider: ModelProvider
+    #: The model to use, as your provider names it (Azure: the deployment name).
+    name: str
+    #: Your API key for the provider. Read it from your own environment; never hard-code it.
+    api_key: str
+
+
+class TaskModel(_TaskModelRequired, total=False):
+    """Your own model for a task.
+
+    The key is used only to run that task: it is kept encrypted until the task
+    starts, and never stored, logged or returned.
+    """
+
+    #: Your provider's https endpoint. Required for ``openai-compatible`` and ``azure``.
+    base_url: str
+
+
+class CreateTaskParams(TypedDict, total=False):
+    """The body of ``POST /v1/tasks``: ``goal``, and ``url`` unless a later task of a session."""
+
+    url: str
+    goal: str
+    #: Run the task in this open session, after its earlier tasks.
+    session_id: str
+    output_schema: JsonSchema
+    #: Values the agent may enter on the site, such as an email address. Never logged.
+    variables: Dict[str, JsonValue]
+    limits: TaskLimits
+    metadata: Dict[str, JsonValue]
+    #: Public http(s) URL that gets a signed ``task.finished`` event when the task finishes.
+    webhook_url: str
+    # Opt-in features, all off by default.
+    #: Your own notes for the site, such as the steps you usually take. Never logged;
+    #: deleted when the task finishes.
+    notes: str
+    #: General know-how for the kind of work: ``"auto"`` or up to three skill names.
+    skills: Union[Literal["auto"], List[SkillId]]
+    #: Reuse the steps of an earlier completed task of yours with the same request.
+    cache: StoredDataMode
+    #: Remember how a website works between your tasks.
+    site_context: StoredDataMode
+    #: Also look at the screen when part of a page is drawn rather than described.
+    vision: Literal["fallback"]
+    #: Run the task with your own model provider key; required when the service holds none.
+    model: TaskModel
+
+
+class Usage(TypedDict):
+    """One API key's usage and cost for a calendar month (UTC)."""
+
+    month: str
+    tasks: int
+    #: Finished tasks that count towards cost: not ones that never started or failed with ``internal_error``.
+    billable_tasks: int
+    unfinished_tasks: int
+    model_calls: int
+    input_tokens: int
+    output_tokens: int
+    browser_seconds: float
+    charged_usd: float
+    #: Held for unfinished tasks until they finish; counts towards the spending limit.
+    reserved_usd: float
+    #: Creates that would pass this monthly limit are refused with ``PermissionDeniedError``.
+    spend_limit_usd: Optional[float]
+
+
+class StepEvent(TypedDict):
+    """A new step of the task's plain-language log."""
+
+    type: Literal["step"]
+    step: TaskStep
+
+
+class StatusEvent(TypedDict):
+    type: Literal["status"]
+    status: TaskStatus
+
+
+class DoneEvent(TypedDict):
+    """The task finished; the last event of ``Tasks.events``."""
+
+    type: Literal["done"]
+    task: Task
+
+
+#: One live event of a task (``GET /v1/tasks/{id}/events``).
+TaskEvent = Union[StepEvent, StatusEvent, DoneEvent]
+
+
+class TaskList(TypedDict):
+    data: List[Task]
+    has_more: bool
+    next_cursor: Optional[str]

browserwhale-0.1.0b1.dist-info/METADATA

@@ -0,0 +1,129 @@
+Metadata-Version: 2.5
+Name: browserwhale
+Version: 0.1.0b1
+Summary: Python client for the hosted Browserwhale web agent API.
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agent,api,automation,browser,sdk,web-agent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# browserwhale (Python)
+
+Python client for the hosted Browserwhale API: give it a URL and a goal in
+plain language, and a web agent does the task in a real, disposable browser.
+
+Install it with `pip install --pre browserwhale` (beta). Python 3.9 or later, no
+dependencies (it uses the standard library).
+
+## Run a task
+
+```python
+from browserwhale import Whale
+
+whale = Whale()  # BROWSERWHALE_API_KEY and BROWSERWHALE_BASE_URL
+
+task = whale.run(
+    url="https://example.com",
+    goal="Find the page's main heading.",
+    output_schema={"type": "object", "properties": {"heading": {"type": "string"}}},
+)
+print(task["output"])  # {'heading': 'Example Domain'}
+for step in task["steps"]:
+    print(step["n"], step["description"])  # 1 Opening the website
+```
+
+`run()` creates the task, waits until it finishes and returns the task
+when it is `completed`. Tasks are plain dicts typed with `TypedDict`
+(`Task`), with the API's snake_case field names.
+
+To run a task in an open session (see the API docs, "Sessions"),
+pass `session_id=`; a later task in it may pass `url=None` to continue on the
+current page. This client does not open or close sessions yet; use the HTTP
+API for that.
+
+## Live progress
+
+Pass `on_progress` to see each step as it happens:
+
+```python
+task = whale.run(
+    url="https://example.com",
+    goal="Find the page's main heading.",
+    on_progress=lambda step: print(f"Step {step['n']} · {step['description']}"),
+)
+```
+
+For more control, `whale.tasks.events(task_id)` yields every `step`, each
+`status` change and finally `done` with the task. It reconnects on its own,
+resuming after the last step it saw:
+
+```python
+for event in whale.tasks.events(task["id"]):
+    if event["type"] == "step":
+        print(event["step"]["description"])
+    elif event["type"] == "done":
+        print(event["task"]["status"])
+```
+
+## Opt-in features
+
+All off by default:
+
+```python
+task = whale.run(
+    url="https://shop.example",
+    goal="Add the cheapest kettle to the cart.",
+    notes="The catalogue is under Shop > Kitchen.",  # your own steps or hints
+    skills="auto",  # or ["shopping"]
+    vision="fallback",  # look at the screen for drawn content such as seat maps
+    cache="read-write",  # reuse an earlier completed run of the same request
+    site_context="read-write",  # remember how the site works between your tasks
+)
+```
+
+`cache` and `site_context` keep data between the tasks of one API key (never
+shared with another key, even in the same team), and only servers that store
+task data accept them.
+
+## Tasks that do not complete
+
+Any other final status raises `TaskFailedError`; its `task` keeps the partial
+`results`, the `limitations` with plain reasons, and the `cause`
+(`site_blocked`, `unavailable`, `limit_reached`, `could_not_complete`,
+`cancelled`, `internal_error`). `run(timeout=...)` (seconds, default 15
+minutes) raises `WaitTimeoutError` when it stops waiting; the task may still
+be running. Interrupting `run()` (Ctrl+C) cancels the task.
+
+## Errors
+
+| Error | When |
+|---|---|
+| `AuthenticationError` | Missing or invalid API key (401). |
+| `InvalidRequestError` | The request failed validation (400, 413, 422); `param` names the field. |
+| `NotFoundError` | No such task for this key (404). |
+| `ConflictError` | An idempotency key reused with a different body (409). |
+| `RateLimitError` | Rate limit or concurrent-task cap reached (429). `retry_after` is in seconds; `code` is `rate_limit_exceeded` or `concurrency_limit_exceeded`. |
+| `InternalServerError` | A server error (5xx). |
+| `APIConnectionError` | No response: a network failure or request timeout. |
+
+All derive from `WhaleError`; the HTTP ones from `ApiError` (`status`, `type`,
+`param`, `request_id`). The client retries 429, 5xx and network failures
+(`max_retries`, default 2), honouring `Retry-After`. Every create carries an
+`Idempotency-Key`, reused across retries, so a retried create never starts a
+second task.
+
+## Usage and cost
+
+`whale.usage(month="2026-11")` returns the key's tasks, model calls, tokens,
+browser time and cost for a calendar month (UTC; the current month by
+default). Tasks that never started or failed with `internal_error` cost
+nothing.
+
+## Lower-level control
+
+`whale.tasks.create(params)`, `get(id, wait=30)`, `list(limit=, cursor=)`,
+`events(id)` and `cancel(id)` map one-to-one to the REST endpoints.

browserwhale-0.1.0b1.dist-info/RECORD

@@ -0,0 +1,10 @@
+browserwhale/__init__.py,sha256=JS2NFbC7LxtY7ej5oKiuLwyQCqpa94YLb0Cg2OvZiw4,2059
+browserwhale/_client.py,sha256=V7fzkNsaUGAIOoUtKGkYwLisLxU220cEdqNNQ8GpCA0,17727
+browserwhale/_errors.py,sha256=5qMfDWHLzjRHJ-Tm9Js4u7chdl6CKnNkCz98TagRoxQ,3851
+browserwhale/_types.py,sha256=ROcLgjfMfkJJ5VMjixth5Dz8j6PeBLdO1yN04BKJJiI,7436
+browserwhale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+browserwhale-0.1.0b1.dist-info/METADATA,sha256=Y1fbCuStQh6niOPiiqeHaOXdA9IuvPKrDiBGD4UreS0,4742
+browserwhale-0.1.0b1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+browserwhale-0.1.0b1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+browserwhale-0.1.0b1.dist-info/licenses/NOTICE,sha256=nzKmdMYe8AX61m4y6RLtcSWQBuApyYNbQmRDwbNW3YI,118
+browserwhale-0.1.0b1.dist-info/RECORD,,

browserwhale-0.1.0b1.dist-info/WHEEL

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

browserwhale-0.1.0b1.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

browserwhale-0.1.0b1.dist-info/licenses/NOTICE

@@ -0,0 +1,4 @@
+Browserwhale Python client
+Copyright 2026 Browserwhale
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).