universal-sandbox 0.0.6__tar.gz

universal_sandbox-0.0.6/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: universal-sandbox
+Version: 0.0.6
+Summary: Python SDK for Universal Sandbox API
+Home-page: https://github.com/universal-sandbox/sdk-python
+Author: Universal Sandbox
+Author-email: support@ai-infra.org
+License: MIT
+Project-URL: Documentation, https://api.sandbox.ai-infra.org/docs
+Project-URL: Source, https://github.com/universal-sandbox/sdk-python
+Project-URL: Bug Reports, https://github.com/universal-sandbox/sdk-python/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Universal Sandbox Python SDK
+
+Python SDK for Universal Sandbox API.
+
+📖 **[API Documentation](https://api.sandbox.ai-infra.org/docs)**
+
+## Installation
+
+```bash
+pip install universal-sandbox
+```
+
+## Usage
+
+For more detailed usage, please refer to [example.py](./example.py)
+
+```python
+from universal_sandbox import Sandbox
+
+# Initialize client
+# Get Sandbox API Token from https://ai-infra.org/
+sandbox = Sandbox(token="sandbox-api-token")
+
+# Check API health
+health = sandbox.check_health()
+print(health.status)
+
+# Create a code interpreter sandbox
+sb = sandbox.code_interpreter.create()
+print(f"Sandbox ID: {sb.id}")
+print(f"Provider: {sb.provider}")
+
+# Execute code
+result = sandbox.sandboxes.execute(sb.id, command="print('Hello, World!')")
+print(result.stdout)
+
+# Get sandbox info
+info = sandbox.sandboxes.get(sb.id)
+print(f"Status: {info.status}")
+
+# List all sandboxes
+sandbox_list = sandbox.sandboxes.list()
+print(f"Total: {sandbox_list.total}")
+
+# Delete sandbox
+sandbox.sandboxes.delete(sb.id)
+```
+
+## API to SDK Mapping
+
+| API Endpoint                       | SDK Interface                        |
+|------------------------------------|--------------------------------------|
+| `GET /health`                      | `sandbox.check_health()`             |
+| `GET /regions`                     | `sandbox.list_regions()`             |
+| `GET /limits`                      | `sandbox.get_limits()`               |
+| `POST /sandboxes/code-interpreter` | `sandbox.code_interpreter.create()`  |
+| `POST /sandboxes/browser`          | `sandbox.browser.create()`           |
+| `POST /sandboxes/aio`              | `sandbox.aio.create()`               |
+| `GET /sandboxes`                   | `sandbox.sandboxes.list()` |
+| `GET /sandboxes/{id}`              | `sandbox.sandboxes.get()`    |
+| `DELETE /sandboxes/{id}`           | `sandbox.sandboxes.delete()` |
+| `POST /sandboxes/{id}/execute`     | `sandbox.sandboxes.execute()`        |
+| `POST /admin/tokens`               | `sandbox.tokens.issue()`             |
+| `POST /admin/tokens/{prefix}/revoke` | `sandbox.tokens.revoke()`          |
+| `GET /admin/users/{user_id}/token` | `sandbox.tokens.get()`               |
+
+## API Reference
+
+### Sandbox Client
+
+```python
+from universal_sandbox import Sandbox
+
+sandbox = Sandbox(
+    token="your-token",           # API token (optional if auth disabled)
+    base_url="https://...",       # Optional, defaults to production
+)
+```
+
+### Root Methods
+
+- `sandbox.check_health()` - Check API health status
+- `sandbox.list_regions()` - List available regions for all providers
+- `sandbox.get_limits()` - Get resource limits and current usage
+
+### Sandbox Creation
+
+- `sandbox.code_interpreter.create(provider, timeout_minutes, region, metadata)` - Create code interpreter
+- `sandbox.browser.create(provider, timeout_minutes, region, metadata)` - Create browser sandbox
+- `sandbox.aio.create(provider, timeout_minutes, region, metadata)` - Create all-in-one sandbox (only supports `provider="volcengine"`)
+
+### Sandbox Management
+
+- `sandbox.sandboxes.list()` - List all sandboxes
+- `sandbox.sandboxes.get(sandbox_id)` - Get sandbox by ID
+- `sandbox.sandboxes.delete(sandbox_id)` - Delete a sandbox
+- `sandbox.sandboxes.execute(sandbox_id, command, timeout)` - Execute command
+
+### Token Management (Admin)
+
+- `sandbox.tokens.issue(...)` - Create a personal access token
+- `sandbox.tokens.revoke(prefix)` - Revoke a token
+- `sandbox.tokens.get(user_id)` - Get user's token

universal_sandbox-0.0.6/README.md

@@ -0,0 +1,103 @@
+# Universal Sandbox Python SDK
+
+Python SDK for Universal Sandbox API.
+
+📖 **[API Documentation](https://api.sandbox.ai-infra.org/docs)**
+
+## Installation
+
+```bash
+pip install universal-sandbox
+```
+
+## Usage
+
+For more detailed usage, please refer to [example.py](./example.py)
+
+```python
+from universal_sandbox import Sandbox
+
+# Initialize client
+# Get Sandbox API Token from https://ai-infra.org/
+sandbox = Sandbox(token="sandbox-api-token")
+
+# Check API health
+health = sandbox.check_health()
+print(health.status)
+
+# Create a code interpreter sandbox
+sb = sandbox.code_interpreter.create()
+print(f"Sandbox ID: {sb.id}")
+print(f"Provider: {sb.provider}")
+
+# Execute code
+result = sandbox.sandboxes.execute(sb.id, command="print('Hello, World!')")
+print(result.stdout)
+
+# Get sandbox info
+info = sandbox.sandboxes.get(sb.id)
+print(f"Status: {info.status}")
+
+# List all sandboxes
+sandbox_list = sandbox.sandboxes.list()
+print(f"Total: {sandbox_list.total}")
+
+# Delete sandbox
+sandbox.sandboxes.delete(sb.id)
+```
+
+## API to SDK Mapping
+
+| API Endpoint                       | SDK Interface                        |
+|------------------------------------|--------------------------------------|
+| `GET /health`                      | `sandbox.check_health()`             |
+| `GET /regions`                     | `sandbox.list_regions()`             |
+| `GET /limits`                      | `sandbox.get_limits()`               |
+| `POST /sandboxes/code-interpreter` | `sandbox.code_interpreter.create()`  |
+| `POST /sandboxes/browser`          | `sandbox.browser.create()`           |
+| `POST /sandboxes/aio`              | `sandbox.aio.create()`               |
+| `GET /sandboxes`                   | `sandbox.sandboxes.list()` |
+| `GET /sandboxes/{id}`              | `sandbox.sandboxes.get()`    |
+| `DELETE /sandboxes/{id}`           | `sandbox.sandboxes.delete()` |
+| `POST /sandboxes/{id}/execute`     | `sandbox.sandboxes.execute()`        |
+| `POST /admin/tokens`               | `sandbox.tokens.issue()`             |
+| `POST /admin/tokens/{prefix}/revoke` | `sandbox.tokens.revoke()`          |
+| `GET /admin/users/{user_id}/token` | `sandbox.tokens.get()`               |
+
+## API Reference
+
+### Sandbox Client
+
+```python
+from universal_sandbox import Sandbox
+
+sandbox = Sandbox(
+    token="your-token",           # API token (optional if auth disabled)
+    base_url="https://...",       # Optional, defaults to production
+)
+```
+
+### Root Methods
+
+- `sandbox.check_health()` - Check API health status
+- `sandbox.list_regions()` - List available regions for all providers
+- `sandbox.get_limits()` - Get resource limits and current usage
+
+### Sandbox Creation
+
+- `sandbox.code_interpreter.create(provider, timeout_minutes, region, metadata)` - Create code interpreter
+- `sandbox.browser.create(provider, timeout_minutes, region, metadata)` - Create browser sandbox
+- `sandbox.aio.create(provider, timeout_minutes, region, metadata)` - Create all-in-one sandbox (only supports `provider="volcengine"`)
+
+### Sandbox Management
+
+- `sandbox.sandboxes.list()` - List all sandboxes
+- `sandbox.sandboxes.get(sandbox_id)` - Get sandbox by ID
+- `sandbox.sandboxes.delete(sandbox_id)` - Delete a sandbox
+- `sandbox.sandboxes.execute(sandbox_id, command, timeout)` - Execute command
+
+### Token Management (Admin)
+
+- `sandbox.tokens.issue(...)` - Create a personal access token
+- `sandbox.tokens.revoke(prefix)` - Revoke a token
+- `sandbox.tokens.get(user_id)` - Get user's token

universal_sandbox-0.0.6/setup.cfg

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

universal_sandbox-0.0.6/setup.py

@@ -0,0 +1,40 @@
+"""Setup script for Universal Sandbox Python SDK."""
+from setuptools import setup, find_packages
+from pathlib import Path
+
+# Read the README file
+readme_file = Path(__file__).parent / "README.md"
+long_description = readme_file.read_text(encoding="utf-8") if readme_file.exists() else ""
+
+setup(
+    name="universal-sandbox",
+    version="0.0.6",
+    description="Python SDK for Universal Sandbox API",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Universal Sandbox",
+    author_email="support@ai-infra.org",
+    url="https://github.com/universal-sandbox/sdk-python",
+    project_urls={
+        "Documentation": "https://api.sandbox.ai-infra.org/docs",
+        "Source": "https://github.com/universal-sandbox/sdk-python",
+        "Bug Reports": "https://github.com/universal-sandbox/sdk-python/issues",
+    },
+    packages=find_packages(),
+    python_requires=">=3.8",
+    install_requires=[
+        "requests>=2.25.0",
+    ],
+    license="MIT",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+)

universal_sandbox-0.0.6/universal_sandbox/__init__.py

@@ -0,0 +1,50 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    CreateSandboxRequest,
+    DeleteResponse,
+    ExecuteRequest,
+    ExecuteResponse,
+    HealthStatus,
+    HttpValidationError,
+    LimitsResponse,
+    SandboxListResponse,
+    SandboxProvider,
+    SandboxResponse,
+    SandboxUrls,
+    TokenResponse,
+    ValidationError,
+    ValidationErrorLocItem,
+)
+from .errors import UnprocessableEntityError
+from . import aio, browser, code_interpreter, sandboxes, tokens
+from .client import AsyncSandbox, Sandbox
+from .environment import SandboxEnvironment
+
+__all__ = [
+    "AsyncSandbox",
+    "CreateSandboxRequest",
+    "DeleteResponse",
+    "ExecuteRequest",
+    "ExecuteResponse",
+    "HealthStatus",
+    "HttpValidationError",
+    "LimitsResponse",
+    "Sandbox",
+    "SandboxEnvironment",
+    "SandboxListResponse",
+    "SandboxProvider",
+    "SandboxResponse",
+    "SandboxUrls",
+    "TokenResponse",
+    "UnprocessableEntityError",
+    "ValidationError",
+    "ValidationErrorLocItem",
+    "aio",
+    "browser",
+    "code_interpreter",
+    "sandboxes",
+    "tokens",
+]

universal_sandbox-0.0.6/universal_sandbox/aio/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

universal_sandbox-0.0.6/universal_sandbox/aio/client.py

@@ -0,0 +1,156 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.sandbox_provider import SandboxProvider
+from ..types.sandbox_response import SandboxResponse
+from .raw_client import AsyncRawAioClient, RawAioClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AioClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAioClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAioClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAioClient
+        """
+        return self._raw_client
+
+    def create(
+        self,
+        *,
+        provider: typing.Optional[SandboxProvider] = OMIT,
+        region: typing.Optional[str] = OMIT,
+        timeout_minutes: typing.Optional[int] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SandboxResponse:
+        """
+        Create a new all-in-one sandbox with shell, MCP, and VNC capabilities.
+
+        Parameters
+        ----------
+        provider : typing.Optional[SandboxProvider]
+            Provider to use (auto-detected if not specified)
+
+        region : typing.Optional[str]
+            Preferred region for the sandbox
+
+        timeout_minutes : typing.Optional[int]
+            Custom timeout in minutes
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Additional metadata
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SandboxResponse
+            Successful Response
+
+        Examples
+        --------
+        from ai_infra import Sandbox
+
+        client = Sandbox(
+            token="YOUR_TOKEN",
+        )
+        client.aio.create()
+        """
+        _response = self._raw_client.create(
+            provider=provider,
+            region=region,
+            timeout_minutes=timeout_minutes,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncAioClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAioClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAioClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAioClient
+        """
+        return self._raw_client
+
+    async def create(
+        self,
+        *,
+        provider: typing.Optional[SandboxProvider] = OMIT,
+        region: typing.Optional[str] = OMIT,
+        timeout_minutes: typing.Optional[int] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SandboxResponse:
+        """
+        Create a new all-in-one sandbox with shell, MCP, and VNC capabilities.
+
+        Parameters
+        ----------
+        provider : typing.Optional[SandboxProvider]
+            Provider to use (auto-detected if not specified)
+
+        region : typing.Optional[str]
+            Preferred region for the sandbox
+
+        timeout_minutes : typing.Optional[int]
+            Custom timeout in minutes
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Additional metadata
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SandboxResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from ai_infra import AsyncSandbox
+
+        client = AsyncSandbox(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.aio.create()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            provider=provider,
+            region=region,
+            timeout_minutes=timeout_minutes,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data

universal_sandbox-0.0.6/universal_sandbox/aio/raw_client.py

@@ -0,0 +1,177 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.http_validation_error import HttpValidationError
+from ..types.sandbox_provider import SandboxProvider
+from ..types.sandbox_response import SandboxResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawAioClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self,
+        *,
+        provider: typing.Optional[SandboxProvider] = OMIT,
+        region: typing.Optional[str] = OMIT,
+        timeout_minutes: typing.Optional[int] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[SandboxResponse]:
+        """
+        Create a new all-in-one sandbox with shell, MCP, and VNC capabilities.
+
+        Parameters
+        ----------
+        provider : typing.Optional[SandboxProvider]
+            Provider to use (auto-detected if not specified)
+
+        region : typing.Optional[str]
+            Preferred region for the sandbox
+
+        timeout_minutes : typing.Optional[int]
+            Custom timeout in minutes
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Additional metadata
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[SandboxResponse]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "sandboxes/aio",
+            method="POST",
+            json={
+                "provider": provider,
+                "region": region,
+                "timeout_minutes": timeout_minutes,
+                "metadata": metadata,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SandboxResponse,
+                    parse_obj_as(
+                        type_=SandboxResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawAioClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self,
+        *,
+        provider: typing.Optional[SandboxProvider] = OMIT,
+        region: typing.Optional[str] = OMIT,
+        timeout_minutes: typing.Optional[int] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[SandboxResponse]:
+        """
+        Create a new all-in-one sandbox with shell, MCP, and VNC capabilities.
+
+        Parameters
+        ----------
+        provider : typing.Optional[SandboxProvider]
+            Provider to use (auto-detected if not specified)
+
+        region : typing.Optional[str]
+            Preferred region for the sandbox
+
+        timeout_minutes : typing.Optional[int]
+            Custom timeout in minutes
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Additional metadata
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[SandboxResponse]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "sandboxes/aio",
+            method="POST",
+            json={
+                "provider": provider,
+                "region": region,
+                "timeout_minutes": timeout_minutes,
+                "metadata": metadata,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SandboxResponse,
+                    parse_obj_as(
+                        type_=SandboxResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

universal_sandbox-0.0.6/universal_sandbox/browser/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+