boxxkite-client 0.2.3__tar.gz

boxxkite_client-0.2.3/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: boxxkite-client
+Version: 0.2.3
+Summary: Python client for a hosted boxxkite control-plane (sandbox creation, exec, files, LangChain tools).
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/EvAlssment/boxxkite
+Project-URL: Repository, https://github.com/EvAlssment/boxxkite
+Project-URL: Issues, https://github.com/EvAlssment/boxxkite/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.27
+Requires-Dist: websockets>=13
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.3; extra == "langchain"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+
+# boxxkite-client
+
+[![PyPI](https://img.shields.io/pypi/v/boxxkite-client?label=PyPI)](https://pypi.org/project/boxxkite-client/)
+
+A Python client for a **hosted** boxxkite control-plane — create sandboxes,
+run commands, edit files, over HTTP. Not the boxxkite package itself
+(`boxxkite-sandbox`, which embeds `SandboxManager` against your own
+Kubernetes cluster) — use this to talk to *someone else's* running
+control-plane, hosted or self-hosted, over its API.
+
+## Install
+
+```bash
+pip install boxxkite-client
+pip install boxxkite-client[langchain]  # for create_sandbox_tools
+```
+
+## Quickstart
+
+```python
+from boxxkite_client import BoxxkiteClient
+
+client = BoxxkiteClient(base_url="https://your-control-plane.example.com", api_key="bxk_live_...")
+
+with client.sandbox(label="demo") as sb:
+    result = sb.exec("python3 -c 'print(1 + 1)'")
+    print(result["stdout"])  # "2\n"
+
+    sb.file_create("notes.txt", "hello from boxxkite-client\n")
+    print(sb.view("notes.txt")["content"])
+# sandbox is destroyed automatically here, even if an exception was raised above
+```
+
+Also available: `AsyncBoxxkiteClient` (same shapes, `async`/`await`),
+file/directory search (`ls`/`glob`/`grep`), long-running background
+processes (`start_process`/`get_process_output`/`stop_process`), signed
+preview URLs for exposing a port, an audit-log feed (`get_log`/`watch`),
+interactive human takeover over a raw WebSocket, desktop (GUI) takeover
+over the same raw-WebSocket pattern, secret management
+(`create_secret`/`list_secrets`/`delete_secret`, for use via
+`create_sandbox(secret_names=[...])`), and a `create_sandbox_tools()`
+LangChain factory. Full reference with examples
+for all of these: [`docs/API.md`](https://github.com/EvAlssment/boxxkite/blob/main/docs/API.md).
+
+## Error handling
+
+Every non-2xx response raises `BoxxkiteApiError` (`.status_code`, `.code`,
+`.message`). A network-level failure raises `BoxxkiteConnectionError`. Both
+subclass `BoxxkiteError`.
+
+```python
+from boxxkite_client import BoxxkiteApiError
+
+try:
+    client.exec(sandbox["id"], "echo hi")
+except BoxxkiteApiError as exc:
+    if exc.code == "concurrent_sandbox_limit_reached":
+        ...  # back off, destroy an old session, etc.
+```
+
+## Retries
+
+Automatic retry is **off by default**. Pass a `RetryConfig` to enable it;
+`RetryConfig()` carries sensible defaults (2 retries, exponential backoff
+with full jitter, `Retry-After` honored):
+
+```python
+from boxxkite_client import BoxxkiteClient, RetryConfig
+
+client = BoxxkiteClient(base_url="...", api_key="...", retry=RetryConfig())
+```
+
+Only idempotent verbs (`GET`/`HEAD`/`PUT`/`DELETE`/`OPTIONS`) are retried,
+and only on a connection failure or a transient status (429, 500, 502, 503,
+504) — a non-idempotent `POST` (create-sandbox/secret/webhook) is never
+retried, so this can't double-create a resource. `AsyncBoxxkiteClient` takes
+the same `retry=` argument and awaits its backoff. Every field of
+`RetryConfig` is tunable if the defaults don't fit.
+
+## Development
+
+```bash
+pip install -e ".[dev,langchain]"
+pytest tests/
+```
+
+Tests mock the control-plane with `httpx.MockTransport` — no real deployment needed.
+
+## Related tools
+
+Moving an in-progress local Claude Code/Codex CLI/opencode session (full
+conversation history, not just a diff) into a fresh boxxkite sandbox is
+handled by the separate `boxxkite-handoff` CLI, built on this SDK — see
+[`../docs/handoff-adapters.md`](../docs/handoff-adapters.md) and
+[`../handoff-cli/README.md`](../handoff-cli/README.md). Not yet published
+to PyPI.
+
+See the [root README](https://github.com/EvAlssment/boxxkite#readme) for
+what boxxkite is and the full self-hosting story.

boxxkite_client-0.2.3/README.md

@@ -0,0 +1,99 @@
+# boxxkite-client
+
+[![PyPI](https://img.shields.io/pypi/v/boxxkite-client?label=PyPI)](https://pypi.org/project/boxxkite-client/)
+
+A Python client for a **hosted** boxxkite control-plane — create sandboxes,
+run commands, edit files, over HTTP. Not the boxxkite package itself
+(`boxxkite-sandbox`, which embeds `SandboxManager` against your own
+Kubernetes cluster) — use this to talk to *someone else's* running
+control-plane, hosted or self-hosted, over its API.
+
+## Install
+
+```bash
+pip install boxxkite-client
+pip install boxxkite-client[langchain]  # for create_sandbox_tools
+```
+
+## Quickstart
+
+```python
+from boxxkite_client import BoxxkiteClient
+
+client = BoxxkiteClient(base_url="https://your-control-plane.example.com", api_key="bxk_live_...")
+
+with client.sandbox(label="demo") as sb:
+    result = sb.exec("python3 -c 'print(1 + 1)'")
+    print(result["stdout"])  # "2\n"
+
+    sb.file_create("notes.txt", "hello from boxxkite-client\n")
+    print(sb.view("notes.txt")["content"])
+# sandbox is destroyed automatically here, even if an exception was raised above
+```
+
+Also available: `AsyncBoxxkiteClient` (same shapes, `async`/`await`),
+file/directory search (`ls`/`glob`/`grep`), long-running background
+processes (`start_process`/`get_process_output`/`stop_process`), signed
+preview URLs for exposing a port, an audit-log feed (`get_log`/`watch`),
+interactive human takeover over a raw WebSocket, desktop (GUI) takeover
+over the same raw-WebSocket pattern, secret management
+(`create_secret`/`list_secrets`/`delete_secret`, for use via
+`create_sandbox(secret_names=[...])`), and a `create_sandbox_tools()`
+LangChain factory. Full reference with examples
+for all of these: [`docs/API.md`](https://github.com/EvAlssment/boxxkite/blob/main/docs/API.md).
+
+## Error handling
+
+Every non-2xx response raises `BoxxkiteApiError` (`.status_code`, `.code`,
+`.message`). A network-level failure raises `BoxxkiteConnectionError`. Both
+subclass `BoxxkiteError`.
+
+```python
+from boxxkite_client import BoxxkiteApiError
+
+try:
+    client.exec(sandbox["id"], "echo hi")
+except BoxxkiteApiError as exc:
+    if exc.code == "concurrent_sandbox_limit_reached":
+        ...  # back off, destroy an old session, etc.
+```
+
+## Retries
+
+Automatic retry is **off by default**. Pass a `RetryConfig` to enable it;
+`RetryConfig()` carries sensible defaults (2 retries, exponential backoff
+with full jitter, `Retry-After` honored):
+
+```python
+from boxxkite_client import BoxxkiteClient, RetryConfig
+
+client = BoxxkiteClient(base_url="...", api_key="...", retry=RetryConfig())
+```
+
+Only idempotent verbs (`GET`/`HEAD`/`PUT`/`DELETE`/`OPTIONS`) are retried,
+and only on a connection failure or a transient status (429, 500, 502, 503,
+504) — a non-idempotent `POST` (create-sandbox/secret/webhook) is never
+retried, so this can't double-create a resource. `AsyncBoxxkiteClient` takes
+the same `retry=` argument and awaits its backoff. Every field of
+`RetryConfig` is tunable if the defaults don't fit.
+
+## Development
+
+```bash
+pip install -e ".[dev,langchain]"
+pytest tests/
+```
+
+Tests mock the control-plane with `httpx.MockTransport` — no real deployment needed.
+
+## Related tools
+
+Moving an in-progress local Claude Code/Codex CLI/opencode session (full
+conversation history, not just a diff) into a fresh boxxkite sandbox is
+handled by the separate `boxxkite-handoff` CLI, built on this SDK — see
+[`../docs/handoff-adapters.md`](../docs/handoff-adapters.md) and
+[`../handoff-cli/README.md`](../handoff-cli/README.md). Not yet published
+to PyPI.
+
+See the [root README](https://github.com/EvAlssment/boxxkite#readme) for
+what boxxkite is and the full self-hosting story.

boxxkite_client-0.2.3/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "boxxkite-client"
+version = "0.2.3"
+description = "Python client for a hosted boxxkite control-plane (sandbox creation, exec, files, LangChain tools)."
+readme = "README.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.10"
+dependencies = [
+    "httpx>=0.27",
+    "websockets>=13",
+]
+
+[project.optional-dependencies]
+langchain = ["langchain-core>=0.3"]
+dev = ["pytest>=8", "ruff>=0.6"]
+
+[project.urls]
+Homepage = "https://github.com/EvAlssment/boxxkite"
+Repository = "https://github.com/EvAlssment/boxxkite"
+Issues = "https://github.com/EvAlssment/boxxkite/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]

boxxkite_client-0.2.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

boxxkite_client-0.2.3/src/boxxkite_client/__init__.py

@@ -0,0 +1,31 @@
+"""boxxkite_client — a Python client for a hosted boxxkite control-plane.
+
+    from boxxkite_client import BoxxkiteClient
+
+    client = BoxxkiteClient(base_url="https://your-control-plane", api_key="bxk_live_...")
+    with client.sandbox(label="demo") as sb:
+        result = sb.exec("echo hello")
+        print(result["stdout"])
+
+See README.md for the async client and LangChain tool factory.
+"""
+
+from .client import (
+    AsyncBoxxkiteClient,
+    AsyncSandboxSession,
+    BoxxkiteClient,
+    RetryConfig,
+    SandboxSession,
+)
+from .exceptions import BoxxkiteApiError, BoxxkiteConnectionError, BoxxkiteError
+
+__all__ = [
+    "AsyncBoxxkiteClient",
+    "AsyncSandboxSession",
+    "BoxxkiteApiError",
+    "BoxxkiteClient",
+    "BoxxkiteConnectionError",
+    "BoxxkiteError",
+    "RetryConfig",
+    "SandboxSession",
+]