Official Python SDK for Tavor, the cloud sandbox platform that provides secure, isolated execution environments.
pip install tavorFor async support:
pip install tavor[async]from tavor import Tavor
# Initialize the client
tavor = Tavor(api_key="sk-tavor-...")
# Create and use a sandbox
with tavor.box() as box:
result = box.run("echo 'Hello from Tavor!'")
print(result.stdout) # "Hello from Tavor!"- Simple API: Intuitive interface for creating and managing boxes
- Automatic cleanup: Boxes are automatically cleaned up when done
- Streaming output: Real-time command output streaming
- Async support: Full async/await support for concurrent operations
- Type hints: Complete type annotations for better IDE support
- Error handling: Comprehensive error handling with specific exception types
from tavor import Tavor
tavor = Tavor(api_key="sk-tavor-...")
with tavor.box() as box:
# Run simple commands
result = box.run("pwd")
print(f"Current directory: {result.stdout}")
# Install packages
box.run("pip install numpy pandas")
# Run Python code
result = box.run("python -c 'import numpy as np; print(np.array([1,2,3]))'")
print(result.stdout)from tavor import Tavor, CommandTimeoutError, TavorError
try:
with tavor.box() as box:
# This will timeout
result = box.run("sleep 120", timeout=5)
except CommandTimeoutError as e:
print(f"Command timed out: {e}")
except TavorError as e:
print(f"Error: {e}")with tavor.box() as box:
# Stream output as it's generated
result = box.run(
"for i in {1..5}; do echo \"Line $i\"; sleep 1; done",
on_stdout=lambda line: print(f"[LIVE] {line}", end=""),
on_stderr=lambda line: print(f"[ERROR] {line}", end="")
)from tavor import Tavor, BoxConfig
config = BoxConfig(
cpu=2,
mib_ram=2048,
timeout=7200, # 2 hours
metadata={"project": "data-analysis"}
)
with tavor.box(config=config) as box:
# Run resource-intensive tasks
result = box.run("python train_model.py")Boxes can expose services to the internet via public URLs. Each box gets a unique hostname, and you can access specific ports using the get_public_url() method:
with tavor.box() as box:
# Start a web server on port 8080
box.run("python -m http.server 8080 &")
# Wait for server to start
box.run("sleep 2")
# Get the public URL for port 8080
public_url = box.get_public_url(8080)
print(f"Access your server at: {public_url}")
# Output: https://8080-uuid.tavor.app
# The service is now accessible from anywhere on the internet
box.run(f"curl {public_url}")This feature is useful for:
- Testing webhooks and callbacks
- Sharing development servers temporarily
- Demonstrating web applications
- Running services that need to be accessible from external systems
import asyncio
from tavor import AsyncTavor
async def run_parallel_tasks():
async with AsyncTavor(api_key="sk-tavor-...") as tavor:
async with tavor.box() as box:
# Run multiple commands in parallel
results = await asyncio.gather(
box.run("task1.py"),
box.run("task2.py"),
box.run("task3.py")
)
for result in results:
print(result.stdout)
asyncio.run(run_parallel_tasks())# Create a box without automatic cleanup
box = tavor.create_box()
try:
# Wait for box to be ready
box.wait_until_ready()
# Run commands
result = box.run("echo 'Hello'")
print(result.stdout)
# Check box status
print(f"Box status: {box.status}")
finally:
# Don't forget to clean up!
box.stop()Tavor: Main client for synchronous operationsAsyncTavor: Client for async operations (requirespip install tavor[async])
BoxConfig: Configuration for box creationcpu: Number of CPUs to allocate (default: 1)mib_ram: MiB RAM to allocate (default: 1024)timeout: Maximum lifetime in seconds (default: 3600, or TAVOR_BOX_TIMEOUT env var)metadata: Custom metadata dictionary
Box: Represents a box instancehostname: Public hostname for web access (e.g.,uuid.tavor.app)get_public_url(port): Get the public URL for accessing a specific port
CommandResult: Result of command executionstdout: Command outputstderr: Error outputexit_code: Process exit codestatus: Command status (QUEUED, RUNNING, DONE, FAILED, ERROR)
TavorError: Base exception for all SDK errorsAPIError: Base for API-related errorsAuthenticationError: Invalid API keyBoxNotFoundError: Box doesn't existCommandTimeoutError: Command execution timeoutValidationError: Invalid request parameters
The SDK supports the following environment variables:
TAVOR_API_KEY: Your API key (alternative to passing it in code)TAVOR_BASE_URL: API base URL (default: https://api.tavor.dev)TAVOR_CPU: CPU to allocate to the sandbox (default: 1)TAVOR_MIB_RAM: MiB RAM to allocate to the sandbox (default: 1024)TAVOR_BOX_TIMEOUT: Default box timeout in seconds (default: 3600)
Example:
export TAVOR_API_KEY="sk-tavor-..."
export TAVOR_BASE_URL="https://api.tavor.dev"
export TAVOR_BOX_TIMEOUT="7200"
export TAVOR_CPU="1"
export TAVOR_MIB_RAM="1024"
# Now you can initialize without parameters
python -c "from tavor import Tavor; client = Tavor()"- Python 3.9+
requestslibraryaiohttp(optional, for async support)
- Documentation: https://tavor.dev
- Issues: https://github.com/tavor-dev/sdk-py/issues
MIT License - see LICENSE file for details.