Skip to main content

Python SDK for Sleigh runtime server.

Project description

Sleigh Python SDK

Python SDK for the Sleigh runtime server.

Two client variants are included:

  • LangChain Tool variant: one-call as_langchain_tool() (returns StructuredTool)
  • MCP variant: expose runtime APIs as MCP tools over stdio

1. Install

pip install .

Optional extras:

pip install ".[langchain]"
pip install ".[mcp]"

2. Base Python Client

from sdk import SleighClient

client = SleighClient(base_url="http://127.0.0.1:8080")
session_token = "sess_demo"
created = client.create_sandbox(session_token=session_token, image="alpine:3.20")
sandbox_id = created["id"]

3. Ordered Workflow (AI Coding)

Run multiple steps in one request and stop early on failure/timeout:

result = client.run_workflow(
    session_token=session_token,
    steps=[
        {"action": "create_sandbox", "image": "alpine:3.20", "memory_limit_mb": 512},
        {"action": "exec_command", "command": "echo hello", "wait": True, "wait_timeout_seconds": 10},
        {"action": "create_snapshot"},
        {"action": "exec_command", "command": "uname -a", "wait": True},
    ],
)
print(result["stopped_early"], result["steps"])

4. Sandbox Read API (AI Coding)

read_result = client.read_sandbox(
    session_token=session_token,
    sandbox_id=sandbox_id,
    command="rg",
    args=["TODO", "/workspace"],
    timeout_seconds=10,
    max_output_bytes=65536,
    max_lines=200,
)
print(read_result)

5. Patch API (Sandbox Semantic)

patch_workspace targets:

  • POST /sandboxes/{id}/ops/patch
  • validates sandbox auth + mounted workspace path ownership
result = client.patch_workspace(
    session_token=session_token,
    sandbox_id=sandbox_id,
    cwd="/home/hxluo/sleigh_env",
    patch="*** Begin Patch\n*** End Patch\n",
)

6. Low-Memory Create Guard

When host available memory ratio:

  • < 5%: create is blocked
  • >= 5% and < 8%: create requires confirm_low_memory=True
created = client.create_sandbox(
    session_token=session_token,
    image="alpine:3.20",
    confirm_low_memory=True,
)

7. More Examples

  • LangChain integration: ../README_langchain.md
  • MCP integration: ../README_mcp.md

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

sleigh_sdk-0.1.1.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

sleigh_sdk-0.1.1-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file sleigh_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: sleigh_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sleigh_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 43dcc2aefdb2c3fc3ec411714df3bdbbadfb26f39bc1590de583a949c8f1443c
MD5 feb93f87791690890bd624db7502813c
BLAKE2b-256 cf4ee3b1675751c2b73fc834987024af5fd9376a3a142f7afc70181faf33c994

See more details on using hashes here.

File details

Details for the file sleigh_sdk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: sleigh_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sleigh_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e1855485b43cbe327dd2f65bb55d1abd5bfab9241bbd400395914960c80a5fe3
MD5 2e392f323cb4363dbf493ade37397664
BLAKE2b-256 ff6597b4c4055c40128ce351edba75753a8d6df673ffe19c0726ee251ba2763b

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