Skip to main content

Python SDK for the All-in-One Sandbox API, >=1.0.0.132

Project description

Agent Sandbox Python SDK

A Python SDK for the All-in-One Sandbox API, providing access to sandbox, shell, file, jupyter, nodejs, and mcp services.

Installation

pip install agent-sandbox

Usage

from agent_sandbox import Sandbox

client = Sandbox(base_url="http://localhost:8091")

ctx = client.sandbox.get_sandbox_context()
print(ctx)

result = client.shell.exec_command(command="ls -la")
print(result)

Async Support

The SDK also provides async support through the AsyncSandbox class:

import asyncio
from agent_sandbox import AsyncSandbox

async def main():
    client = AsyncSandbox(base_url="http://localhost:8091")
    
    # Get sandbox context
    ctx = await client.sandbox.get_sandbox_context()
    print(ctx)

    result = await client.shell.exec_command(command="ls -la")
    print(result)

asyncio.run(main())

Cloud Providers

Volcengine

Create a sandbox instance using the Volcengine provider. For more details, please refer to examples/provider_volcengine.py.

from __future__ import print_function

import os
import sys

# Add the parent directory to Python path so we can import agent_sandbox
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

from agent_sandbox.providers import VolcengineProvider


def main():
    """
    Main function demonstrating Volcengine provider usage.
    """
    # Configuration - replace with your actual credentials
    access_key = os.getenv("VOLC_ACCESSKEY")
    secret_key = os.getenv("VOLC_SECRETKEY")
    region = os.getenv("VOLCENGINE_REGION", "cn-beijing")
    
    # Initialize the Volcengine provider
    provider = VolcengineProvider(
        access_key=access_key,
        secret_key=secret_key,
        region=region
    )
    
    print("=== Volcengine Sandbox Provider Example ===\n")
    
    function_id = "yatoczqh"
    
    print("1. Creating a sandbox...")
    sandbox_id = provider.create_sandbox(function_id=function_id)
    print(f"Create response: {sandbox_id}")


if __name__ == "__main__":
    main()

Features

  • Sandbox: Access sandbox environment information and installed packages
  • Shell: Execute shell commands with session management
  • File: Read, write, search, and manage files
  • Jupyter: Execute Python code in Jupyter kernels
  • Node.js: Execute JavaScript code in Node.js environment
  • MCP: Interact with Model Context Protocol servers

Requirements

  • Python 3.8+
  • httpx
  • pydantic
  • typing_extensions (for Python < 3.10)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_sandbox-0.0.14.tar.gz (61.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_sandbox-0.0.14-py2.py3-none-any.whl (133.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file agent_sandbox-0.0.14.tar.gz.

File metadata

  • Download URL: agent_sandbox-0.0.14.tar.gz
  • Upload date:
  • Size: 61.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.12

File hashes

Hashes for agent_sandbox-0.0.14.tar.gz
Algorithm Hash digest
SHA256 a1972e4a493273ebda1d5f864c88d691db80f2473287673206e0b52e0b973cf5
MD5 63e5366b4c99d6ab45d4c162547d1f2c
BLAKE2b-256 3ff31a149b907be9acd9a40d8396df69205dbf6918a4b50e4bebcb163805ddbe

See more details on using hashes here.

File details

Details for the file agent_sandbox-0.0.14-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for agent_sandbox-0.0.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 016d3bcc7d6b357aa44ffa752b469a447cbeccf5d88f5a5daa058d59b0729ec0
MD5 1a098bdb680c3415087fa2094137a80c
BLAKE2b-256 3c98216f8f54488f84ecd357cf84a84e29d02b3027a1c859532d481bf3e814ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page