islo 0.2.4

Typed Python SDK for the Islo sandbox platform

Islo Python Library

The Islo Python library provides convenient access to the Islo APIs from Python.

Table of Contents

• Installation
• Quick Start
• Authentication
• Configuration
• Async Support
• Development
• Reference
• Usage
• Async Client
• Exception Handling
• Advanced
  • Access Raw Response Data
  • Retries
  • Timeouts
  • Custom Client
• Contributing

Installation

pip install islo

Quick Start

from islo import Islo

# Automatically reads ISLO_API_KEY from environment
client = Islo()

# Create a sandbox
sandbox = client.sandboxes.create_sandbox(
    name="my-sandbox",
    image="ubuntu:22.04",
    vcpus=2,
    memory_mb=4096,
)

# Execute a command
result = client.sandboxes.exec_in_sandbox(
    sandbox_name=sandbox.name,
    command=["echo", "hello world"],
)
print(result.exit_code)

# Clean up
client.sandboxes.delete_sandbox(sandbox_name=sandbox.name)

Authentication

Environment variable (recommended)

export ISLO_API_KEY="your-api-key"

client = Islo()  # Picks up ISLO_API_KEY automatically

Explicit token

client = Islo(token="your-api-key")

Auto-refreshing token provider

from islo import Islo
from islo.custom import SyncTokenProvider

provider = SyncTokenProvider(
    base_url="https://api.islo.dev",
    access_key="your-access-key",
)
client = Islo(token=provider)

Configuration

Environment Variable	Description	Default
ISLO_API_KEY	Bearer token for authentication	—
ISLO_BASE_URL	API base URL	https://api.islo.dev

Async Support

import asyncio
from islo import AsyncIslo

async def main():
    client = AsyncIslo()
    sandboxes = await client.sandboxes.list_sandboxes()
    print(f"Found {len(sandboxes.items)} sandboxes")

asyncio.run(main())

Development

# Install dependencies
uv sync --dev

# Run tests
uv run pytest tests/ -v

# Lint
uv run ruff check .
uv run ruff format --check .

Regenerating the SDK

This SDK is generated by Fern from the OpenAPI spec maintained in islo-web-api. Fern runs from that repo and pushes the generated code here.

Custom code in src/islo/client.py and src/islo/custom/ is preserved across regenerations via .fernignore.

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from islo import Islo

client = Islo(
    api_key="<token>",
    base_url="https://yourhost.com/path/to/api",
)

client.sandboxes.create_sandbox()

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from islo import AsyncIslo

client = AsyncIslo(
    api_key="<token>",
    base_url="https://yourhost.com/path/to/api",
)


async def main() -> None:
    await client.sandboxes.create_sandbox()


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from islo.core.api_error import ApiError

try:
    client.sandboxes.create_sandbox(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from islo import Islo

client = Islo(...)
response = client.sandboxes.with_raw_response.create_sandbox(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.sandboxes.create_sandbox(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from islo import Islo

client = Islo(..., timeout=20.0)

# Override timeout for a specific method
client.sandboxes.create_sandbox(..., request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from islo import Islo

client = Islo(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!