browserwhale 0.1.0b1__tar.gz

browserwhale-0.1.0b1/.gitignore

@@ -0,0 +1,3 @@
+__pycache__/
+*.pyc
+dist/

browserwhale-0.1.0b1/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/NOTICE

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

browserwhale-0.1.0b1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,116 @@
+# 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/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "browserwhale"
+version = "0.1.0b1"
+description = "Python client for the hosted Browserwhale web agent API."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+# No runtime dependencies: the client uses the standard library only.
+dependencies = []
+keywords = ["browser", "agent", "web-agent", "automation", "api", "sdk"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Typing :: Typed",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/browserwhale"]
+
+# The source archive carries the package and its licence only; the tests stay in the repository.
+[tool.hatch.build.targets.sdist]
+include = ["src/browserwhale", "README.md", "LICENSE", "NOTICE", "pyproject.toml"]

browserwhale-0.1.0b1/src/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",
+]