Python SDK overview

pip install sandkiln

Everything this SDK wraps is listed under Sandbox, Image, Drive, and Pool. Two daemon features have no wrapper yet, both available only via the JS/TS SDK, the CLI, or the daemon HTTP API directly: streamed background exec (exec_stream, following a long-running command’s live output) and interactive pty sessions. Remote storage mounts are wrapped here (sandbox.mount()/.list_mounts()/.unmount()) — see Drives for the full mechanics.

Every class below also ships as an asyncio-native mirror — AsyncSandbox, AsyncDrive, AsyncImage, AsyncPool — with identical method names and arguments, just async def and awaited. They’re deliberately separate classes rather than sync+async methods on one class, since a sync call in an async context blocks the event loop silently. AsyncSandbox additionally exposes tunnel() (see below) as an awaitable.

Configuration

Daemon URL: pass base_url= to any method, or set SANDKILN_DAEMON_URL. Defaults to http://127.0.0.1:7777.
Auth: pass auth_token=, or set SANDKILN_AUTH_TOKEN. Omit entirely for an unauthenticated local daemon.

import os
from sandkiln import Sandbox

# Explicit per-call config...
sandbox = Sandbox.create(base_url="https://daemon.internal:7777", auth_token=os.environ["SANDKILN_TOKEN"])

# ...or set both as environment variables once and omit them everywhere:
# SANDKILN_DAEMON_URL=https://daemon.internal:7777
# SANDKILN_AUTH_TOKEN=...
same_sandbox = Sandbox.create()

​Configuration

Configuration