boxrouter 0.0.1a2__tar.gz

boxrouter-0.0.1a2/LICENSE

@@ -0,0 +1,89 @@
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms.  Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures.  Goods and services compete even when provided free of charge.  If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce [Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+**Affiliates** means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+**Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

boxrouter-0.0.1a2/NOTICE

@@ -0,0 +1,8 @@
+BoxRouter Python SDK
+Copyright 2026 BoxRouter, Inc.
+
+Licensed under PolyForm Shield License 1.0.0. See LICENSE or
+https://polyformproject.org/licenses/shield/1.0.0.
+
+Required Notice: Copyright 2026 BoxRouter, Inc.
+Licensor Line of Business: BoxRouter sandbox provisioning, routing, and management products and services.

boxrouter-0.0.1a2/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: boxrouter
+Version: 0.0.1a2
+Summary: Python client for creating and managing BoxRouter cloud sandboxes
+License-Expression: LicenseRef-PolyForm-Shield-1.0.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: httpx>=0.27,<1
+Requires-Python: >=3.11
+Project-URL: Homepage, https://boxrouter.ai
+Description-Content-Type: text/markdown
+
+# BoxRouter Python SDK — alpha
+
+BoxRouter is a Python client for the BoxRouter API. It creates temporary cloud
+sandboxes, runs commands in them, reads their status, and requests their deletion.
+A sandbox request can name eligible cloud providers; BoxRouter evaluates the
+request and routes it to a provider that can satisfy it.
+
+Requires Python 3.11 or later and a BoxRouter API key.
+
+```sh
+python -m pip install --pre boxrouter
+```
+
+Set `BOXROUTER_API_KEY` in your environment. The client uses
+`https://boxrouter.ai/api/v1` by default; set `BOXROUTER_BASE_URL` to use another
+deployment.
+
+```python
+from boxrouter import BoxRouter
+
+with BoxRouter() as client:
+    with client.sandboxes.create(
+        providers=["e2b", "modal"], lifetime_seconds=600
+    ) as sandbox:
+        result = sandbox.exec("python --version")
+        print(result.stdout, end="")
+        print(sandbox.get()["state"])
+```
+
+The `providers` argument is an allowlist: BoxRouter routes only among the named
+providers that meet the sandbox requirements. The client does not retry a
+mutation automatically. If a request outcome is uncertain, `BoxRouterError`
+exposes its `idempotency_key` so the same operation can be reconciled safely.
+
+This alpha includes sandbox creation, command execution, status reads, and
+sandbox deletion. Its API may change before the full SDK release.
+
+Licensed under PolyForm Shield 1.0.0; see [LICENSE](LICENSE). Contact:
+maintainer@boxrouter.ai.

boxrouter-0.0.1a2/README.md

@@ -0,0 +1,39 @@
+# BoxRouter Python SDK — alpha
+
+BoxRouter is a Python client for the BoxRouter API. It creates temporary cloud
+sandboxes, runs commands in them, reads their status, and requests their deletion.
+A sandbox request can name eligible cloud providers; BoxRouter evaluates the
+request and routes it to a provider that can satisfy it.
+
+Requires Python 3.11 or later and a BoxRouter API key.
+
+```sh
+python -m pip install --pre boxrouter
+```
+
+Set `BOXROUTER_API_KEY` in your environment. The client uses
+`https://boxrouter.ai/api/v1` by default; set `BOXROUTER_BASE_URL` to use another
+deployment.
+
+```python
+from boxrouter import BoxRouter
+
+with BoxRouter() as client:
+    with client.sandboxes.create(
+        providers=["e2b", "modal"], lifetime_seconds=600
+    ) as sandbox:
+        result = sandbox.exec("python --version")
+        print(result.stdout, end="")
+        print(sandbox.get()["state"])
+```
+
+The `providers` argument is an allowlist: BoxRouter routes only among the named
+providers that meet the sandbox requirements. The client does not retry a
+mutation automatically. If a request outcome is uncertain, `BoxRouterError`
+exposes its `idempotency_key` so the same operation can be reconciled safely.
+
+This alpha includes sandbox creation, command execution, status reads, and
+sandbox deletion. Its API may change before the full SDK release.
+
+Licensed under PolyForm Shield 1.0.0; see [LICENSE](LICENSE). Contact:
+maintainer@boxrouter.ai.

boxrouter-0.0.1a2/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["uv_build==0.12.12"]
+build-backend = "uv_build"
+
+[project]
+name = "boxrouter"
+version = "0.0.1a2"
+description = "Python client for creating and managing BoxRouter cloud sandboxes"
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+]
+dependencies = ["httpx>=0.27,<1"]
+license = "LicenseRef-PolyForm-Shield-1.0.0"
+license-files = [
+    "LICENSE",
+    "NOTICE",
+]
+
+[project.urls]
+Homepage = "https://boxrouter.ai"
+
+[tool.uv.build-backend]
+module-root = "src"
+module-name = "boxrouter"

boxrouter-0.0.1a2/pyproject.toml.orig

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["uv_build==0.12.12"]
+build-backend = "uv_build"
+
+[project]
+name = "boxrouter"
+version = "0.0.1a2"
+description = "Python client for creating and managing BoxRouter cloud sandboxes"
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+]
+dependencies = ["httpx>=0.27,<1"]
+license = "LicenseRef-PolyForm-Shield-1.0.0"
+license-files = [
+    "LICENSE",
+    "NOTICE",
+]
+
+[project.urls]
+Homepage = "https://boxrouter.ai"
+
+[tool.uv.build-backend]
+module-root = "src"
+module-name = "boxrouter"

boxrouter-0.0.1a2/src/boxrouter/__init__.py

@@ -0,0 +1,5 @@
+"""BoxRouter Python API client."""
+
+from .client import BoxRouter, BoxRouterError
+
+__all__ = ["BoxRouter", "BoxRouterError"]

boxrouter-0.0.1a2/src/boxrouter/client.py

@@ -0,0 +1,212 @@
+"""Minimal Python client for BoxRouter sandbox API operations."""
+
+from __future__ import annotations
+
+import os
+from collections.abc import Mapping
+from dataclasses import dataclass
+from typing import Any
+from urllib.parse import quote
+from uuid import uuid4
+
+import httpx
+
+
+class BoxRouterError(RuntimeError):
+    """An API or transport error from a BoxRouter request."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: int | None = None,
+        response: Any = None,
+        idempotency_key: str | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.response = response
+        self.idempotency_key = idempotency_key
+
+
+class BoxRouter:
+    """Call BoxRouter to provision, use, inspect and delete cloud sandboxes."""
+
+    def __init__(
+        self,
+        api_key: str | None = None,
+        *,
+        base_url: str | None = None,
+        timeout: float = 60.0,
+        transport: httpx.BaseTransport | None = None,
+    ) -> None:
+        key = api_key or os.getenv("BOXROUTER_API_KEY")
+        if not key:
+            raise ValueError("Pass api_key or set BOXROUTER_API_KEY")
+        endpoint = (
+            base_url or os.getenv("BOXROUTER_BASE_URL") or "https://boxrouter.ai/api/v1"
+        ).rstrip("/")
+        self._client = httpx.Client(
+            base_url=f"{endpoint}/",
+            headers={"Authorization": f"Bearer {key}"},
+            timeout=timeout,
+            transport=transport,
+        )
+        self.sandboxes = _Sandboxes(self)
+
+    def create_sandbox(
+        self,
+        request: Mapping[str, Any] | None = None,
+        *,
+        idempotency_key: str | None = None,
+    ) -> dict[str, Any]:
+        """Create a sandbox; `providers` in request limits eligible cloud providers."""
+        result = self._request(
+            "POST", "sandboxes", body=dict(request or {}), idempotency_key=idempotency_key
+        )
+        return self._object(result)
+
+    def get_sandbox(self, sandbox_id: str) -> dict[str, Any]:
+        """Read the current BoxRouter record for a sandbox."""
+        result = self._request("GET", f"sandboxes/{quote(sandbox_id, safe='')}")
+        return self._object(result)
+
+    def run_command(
+        self,
+        sandbox_id: str,
+        command: str,
+        *,
+        timeout_seconds: int = 60,
+        idempotency_key: str | None = None,
+    ) -> dict[str, Any]:
+        """Execute one command in a sandbox and return its output and exit code."""
+        result = self._request(
+            "POST",
+            f"sandboxes/{quote(sandbox_id, safe='')}/commands",
+            body={"command": command, "timeout_seconds": timeout_seconds},
+            idempotency_key=idempotency_key,
+        )
+        return self._object(result)
+
+    def delete_sandbox(self, sandbox_id: str) -> None:
+        """Request destruction of a sandbox."""
+        self._request("DELETE", f"sandboxes/{quote(sandbox_id, safe='')}")
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> BoxRouter:
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.close()
+
+    @staticmethod
+    def _object(value: Any) -> dict[str, Any]:
+        if not isinstance(value, dict):
+            raise BoxRouterError("BoxRouter returned an unexpected response")
+        return value
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        body: Mapping[str, Any] | None = None,
+        idempotency_key: str | None = None,
+    ) -> Any:
+        key = idempotency_key or uuid4().hex if method in {"POST", "PUT", "PATCH"} else None
+        headers = {"Idempotency-Key": key} if key else None
+        try:
+            response = self._client.request(
+                method, path, json=dict(body) if body is not None else None, headers=headers
+            )
+        except httpx.HTTPError as error:
+            raise BoxRouterError(
+                "BoxRouter request outcome is unknown; reconcile before retrying",
+                idempotency_key=key,
+            ) from error
+        if response.is_error:
+            try:
+                detail: Any = response.json()
+            except ValueError:
+                detail = response.text
+            raise BoxRouterError(
+                f"BoxRouter request failed with HTTP {response.status_code}",
+                status_code=response.status_code,
+                response=detail,
+                idempotency_key=key,
+            )
+        if response.status_code == 204 or not response.content:
+            return None
+        return response.json()
+
+
+@dataclass(frozen=True)
+class CommandResult:
+    """Text output and exit status from one sandbox command."""
+
+    stdout: str
+    stderr: str
+    exit_code: int
+
+
+class _Sandboxes:
+    def __init__(self, client: BoxRouter) -> None:
+        self._client = client
+
+    def create(
+        self,
+        *,
+        providers: list[str] | None = None,
+        lifetime_seconds: int | None = None,
+        **request: Any,
+    ) -> _SandboxHandle:
+        body = dict(request)
+        if providers is not None:
+            body["providers"] = providers
+        if lifetime_seconds is not None:
+            body["lifetime_seconds"] = lifetime_seconds
+        return _SandboxHandle(self._client, self._client.create_sandbox(body))
+
+    def get(self, sandbox_id: str) -> _SandboxHandle:
+        return _SandboxHandle(self._client, self._client.get_sandbox(sandbox_id))
+
+    def delete(self, sandbox_id: str) -> None:
+        self._client.delete_sandbox(sandbox_id)
+
+
+class _SandboxHandle:
+    def __init__(self, client: BoxRouter, metadata: Mapping[str, Any]) -> None:
+        sandbox_id = metadata.get("id")
+        if not isinstance(sandbox_id, str) or not sandbox_id:
+            raise BoxRouterError("BoxRouter response did not include a sandbox ID")
+        self._client = client
+        self.id = sandbox_id
+
+    def exec(self, command: str, *, timeout_seconds: int = 60) -> CommandResult:
+        result = self._client.run_command(self.id, command, timeout_seconds=timeout_seconds)
+        stdout, stderr, exit_code = (
+            result.get("stdout", ""),
+            result.get("stderr", ""),
+            result.get("exit_code"),
+        )
+        if (
+            not isinstance(stdout, str)
+            or not isinstance(stderr, str)
+            or not isinstance(exit_code, int)
+        ):
+            raise BoxRouterError("BoxRouter returned an unexpected command result")
+        return CommandResult(stdout, stderr, exit_code)
+
+    def get(self) -> dict[str, Any]:
+        return self._client.get_sandbox(self.id)
+
+    def destroy(self) -> None:
+        self._client.delete_sandbox(self.id)
+
+    def __enter__(self) -> _SandboxHandle:
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.destroy()