steerpane-sdk 0.1.0__tar.gz

steerpane_sdk-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+node_modules/
+dist/
+build/
+.venv/
+__pycache__/
+*.egg-info/
+*.tgz
+.pytest_cache/
+.env

steerpane_sdk-0.1.0/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.

steerpane_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.5
+Name: steerpane-sdk
+Version: 0.1.0
+Summary: Python client for Steerpane: remote browsers for AI agents, with human takeover.
+Project-URL: Homepage, https://steerpane.app
+Project-URL: Repository, https://github.com/Steerpane/sdks
+Author: Steerpane
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,automation,browser,cdp,mcp,playwright
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: playwright
+Requires-Dist: playwright>=1.45; extra == 'playwright'
+Description-Content-Type: text/markdown
+
+# Steerpane Python SDK
+
+A small typed client for [Steerpane](https://steerpane.app): remote Chromium sessions for AI agents, with saved logins and human takeover.
+
+```bash
+pip install steerpane-sdk                # the client
+pip install "steerpane-sdk[playwright]"  # and the Playwright helper
+```
+
+Python 3.10 or newer. Create an API token in the dashboard, then set `STEERPANE_API_TOKEN`. Set `STEERPANE_API_URL` if your API isn't the default one in `steerpane.DEFAULT_BASE_URL`.
+
+```python
+from steerpane import Steerpane
+
+client = Steerpane()  # or Steerpane(token="stp_live_...", base_url="https://...")
+
+session = client.sessions.create(initial_url="https://example.com", auto_close=True)
+client.sessions.wait_until_ready(session["id"])
+
+print(client.actions.get_page_text(session["id"])["text"][:200])
+client.sessions.stop(session["id"])
+```
+
+`AsyncSteerpane` has the same methods, awaited.
+
+Results are plain dicts with `TypedDict` types, so your editor knows the fields and new API fields pass straight through. The field names are the API's own.
+
+## What's in it
+
+| Attribute | Covers |
+|---|---|
+| `client.sessions` | create, get, list, stop, delete, keepalive, takeover, handback, help requests, `wait_until_ready`, `wait_for_human` |
+| `client.actions` | Browser actions: `navigate`, `click`, `type`, `press_key`, `snapshot`, `form_fields`, `select_option`, `get_page_text`, `screenshot`, `execute`, `download`, `upload_file`, `vault_fill`, or `run(session_id, type, **args)` for any other |
+| `client.profiles` | create, list, get, update, delete, clone, verify logins, lock state, import cookies |
+| `client.fetch`, `fetch_batch`, `search`, `screenshot`, `pdf`, `map`, `extract` | One call each, with no session to manage |
+| `client.crawls` | Background crawls, `wait`, and `check_links` reports |
+| `client.runs` | Hosted agent runs, using your own model key: create, get, list, messages, cancel, `wait` |
+| `client.files` | File store: upload, list, get, download, delete, upload URLs |
+| `client.embeds` | Embed links for takeover inside your product (Scale and Enterprise plans) |
+| `client.webhooks`, `client.vault` | Webhook endpoints and stored logins |
+| `client.mcp` | Any MCP tool by name, including MCP-only ones such as `act`, `observe` and `wait_for_code` |
+| `client.request(method, path, ...)` | Any other endpoint |
+
+Use `client.paginate(client.sessions.list, status="live")` to walk every page of a list.
+
+## Playwright over CDP
+
+```python
+from steerpane import Steerpane
+from steerpane.playwright import connect
+
+client = Steerpane()
+session = client.sessions.create(initial_url="https://example.com")
+
+with connect(client, session, agent="my-script") as browser:
+    page = browser.contexts[0].pages[0]
+    print(page.title())
+
+client.sessions.stop(session["id"])
+```
+
+The token is sent in a header, not the URL. Leaving the `with` block closes the connection and leaves the session running. While a person has control, input and navigation commands are held until they hand back.
+
+## When a person is in control
+
+A browser action made during a takeover is queued and raises `HumanInControlError`. Wait, then carry on:
+
+```python
+from steerpane import HumanInControlError
+
+try:
+    client.actions.click(session_id, "#next")
+except HumanInControlError:
+    result = client.sessions.wait_for_human(session_id, timeout_s=60)
+    print(result["status"], result["outcome"], result["note"])
+```
+
+Pass `wait_s=120` to an action to hold the call instead of raising. `outcome` is `done`, `not_done`, or `None` if the person didn't say. To read the answer after control is already back, pass the id from `sessions.request_help` to `wait_for_human`, or read the session's `last_handback`.
+
+## Webhooks
+
+```python
+from steerpane import construct_event, WebhookSignatureError
+
+def handle(raw_body: bytes, headers) -> None:
+    try:
+        event = construct_event(raw_body, headers, WEBHOOK_SECRET)
+    except WebhookSignatureError:
+        return respond(400)
+    ...  # deliveries can repeat, so deduplicate on event["id"]
+```
+
+This rejects timestamps more than 5 minutes off, and accepts either secret during the 24 hours after a rotation.
+
+## Errors and retries
+
+Every API error raises `APIError` with `status`, `code`, `message`, `details` and `retry_after`. Branch on `code`.
+
+GET and DELETE retry on 502, 503, 504, connection errors and `rate_limited`, twice by default (`max_retries=`). `sessions.create` and `runs.create` send an `Idempotency-Key`, so they retry safely too. Other POSTs retry only on `rate_limited`, which means they never ran. `quota_exceeded` is never retried.
+
+The client refuses to send a token over plain `http://` except to localhost, unless you pass `allow_insecure_http=True`.
+
+## Licence
+
+Apache-2.0. This package is only the client. The Steerpane service is separate and has its own terms.

steerpane_sdk-0.1.0/README.md

@@ -0,0 +1,105 @@
+# Steerpane Python SDK
+
+A small typed client for [Steerpane](https://steerpane.app): remote Chromium sessions for AI agents, with saved logins and human takeover.
+
+```bash
+pip install steerpane-sdk                # the client
+pip install "steerpane-sdk[playwright]"  # and the Playwright helper
+```
+
+Python 3.10 or newer. Create an API token in the dashboard, then set `STEERPANE_API_TOKEN`. Set `STEERPANE_API_URL` if your API isn't the default one in `steerpane.DEFAULT_BASE_URL`.
+
+```python
+from steerpane import Steerpane
+
+client = Steerpane()  # or Steerpane(token="stp_live_...", base_url="https://...")
+
+session = client.sessions.create(initial_url="https://example.com", auto_close=True)
+client.sessions.wait_until_ready(session["id"])
+
+print(client.actions.get_page_text(session["id"])["text"][:200])
+client.sessions.stop(session["id"])
+```
+
+`AsyncSteerpane` has the same methods, awaited.
+
+Results are plain dicts with `TypedDict` types, so your editor knows the fields and new API fields pass straight through. The field names are the API's own.
+
+## What's in it
+
+| Attribute | Covers |
+|---|---|
+| `client.sessions` | create, get, list, stop, delete, keepalive, takeover, handback, help requests, `wait_until_ready`, `wait_for_human` |
+| `client.actions` | Browser actions: `navigate`, `click`, `type`, `press_key`, `snapshot`, `form_fields`, `select_option`, `get_page_text`, `screenshot`, `execute`, `download`, `upload_file`, `vault_fill`, or `run(session_id, type, **args)` for any other |
+| `client.profiles` | create, list, get, update, delete, clone, verify logins, lock state, import cookies |
+| `client.fetch`, `fetch_batch`, `search`, `screenshot`, `pdf`, `map`, `extract` | One call each, with no session to manage |
+| `client.crawls` | Background crawls, `wait`, and `check_links` reports |
+| `client.runs` | Hosted agent runs, using your own model key: create, get, list, messages, cancel, `wait` |
+| `client.files` | File store: upload, list, get, download, delete, upload URLs |
+| `client.embeds` | Embed links for takeover inside your product (Scale and Enterprise plans) |
+| `client.webhooks`, `client.vault` | Webhook endpoints and stored logins |
+| `client.mcp` | Any MCP tool by name, including MCP-only ones such as `act`, `observe` and `wait_for_code` |
+| `client.request(method, path, ...)` | Any other endpoint |
+
+Use `client.paginate(client.sessions.list, status="live")` to walk every page of a list.
+
+## Playwright over CDP
+
+```python
+from steerpane import Steerpane
+from steerpane.playwright import connect
+
+client = Steerpane()
+session = client.sessions.create(initial_url="https://example.com")
+
+with connect(client, session, agent="my-script") as browser:
+    page = browser.contexts[0].pages[0]
+    print(page.title())
+
+client.sessions.stop(session["id"])
+```
+
+The token is sent in a header, not the URL. Leaving the `with` block closes the connection and leaves the session running. While a person has control, input and navigation commands are held until they hand back.
+
+## When a person is in control
+
+A browser action made during a takeover is queued and raises `HumanInControlError`. Wait, then carry on:
+
+```python
+from steerpane import HumanInControlError
+
+try:
+    client.actions.click(session_id, "#next")
+except HumanInControlError:
+    result = client.sessions.wait_for_human(session_id, timeout_s=60)
+    print(result["status"], result["outcome"], result["note"])
+```
+
+Pass `wait_s=120` to an action to hold the call instead of raising. `outcome` is `done`, `not_done`, or `None` if the person didn't say. To read the answer after control is already back, pass the id from `sessions.request_help` to `wait_for_human`, or read the session's `last_handback`.
+
+## Webhooks
+
+```python
+from steerpane import construct_event, WebhookSignatureError
+
+def handle(raw_body: bytes, headers) -> None:
+    try:
+        event = construct_event(raw_body, headers, WEBHOOK_SECRET)
+    except WebhookSignatureError:
+        return respond(400)
+    ...  # deliveries can repeat, so deduplicate on event["id"]
+```
+
+This rejects timestamps more than 5 minutes off, and accepts either secret during the 24 hours after a rotation.
+
+## Errors and retries
+
+Every API error raises `APIError` with `status`, `code`, `message`, `details` and `retry_after`. Branch on `code`.
+
+GET and DELETE retry on 502, 503, 504, connection errors and `rate_limited`, twice by default (`max_retries=`). `sessions.create` and `runs.create` send an `Idempotency-Key`, so they retry safely too. Other POSTs retry only on `rate_limited`, which means they never ran. `quota_exceeded` is never retried.
+
+The client refuses to send a token over plain `http://` except to localhost, unless you pass `allow_insecure_http=True`.
+
+## Licence
+
+Apache-2.0. This package is only the client. The Steerpane service is separate and has its own terms.

steerpane_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "steerpane-sdk"
+version = "0.1.0"
+description = "Python client for Steerpane: remote browsers for AI agents, with human takeover."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Steerpane" }]
+keywords = ["browser", "automation", "agents", "playwright", "cdp", "mcp"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Typing :: Typed",
+]
+dependencies = ["httpx>=0.27,<1"]
+
+[project.optional-dependencies]
+playwright = ["playwright>=1.45"]
+
+[project.urls]
+Homepage = "https://steerpane.app"
+Repository = "https://github.com/Steerpane/sdks"
+
+[dependency-groups]
+dev = ["pytest>=8", "pyright>=1.1.380", "build>=1.2", "twine>=5"]
+
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/steerpane"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/steerpane", "README.md", "LICENSE", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = ["live: needs a running API (STEERPANE_API_URL and STEERPANE_API_TOKEN)"]
+
+[tool.pyright]
+include = ["src"]
+typeCheckingMode = "standard"

steerpane_sdk-0.1.0/src/steerpane/__init__.py

@@ -0,0 +1,20 @@
+"""Steerpane: remote browsers for AI agents, with human takeover."""
+from ._async_client import AsyncSteerpane
+from ._client import DEFAULT_BASE_URL, Steerpane
+from ._version import __version__
+from .errors import APIError, HumanInControlError, SteerpaneError, ToolError
+from .webhooks import WebhookSignatureError, construct_event, verify_signature
+
+__all__ = [
+    "APIError",
+    "AsyncSteerpane",
+    "DEFAULT_BASE_URL",
+    "HumanInControlError",
+    "Steerpane",
+    "SteerpaneError",
+    "ToolError",
+    "WebhookSignatureError",
+    "__version__",
+    "construct_event",
+    "verify_signature",
+]