Metadata-Version: 2.3
Name: islo
Version: 0.3.0
Summary: Typed Python SDK for the Islo sandbox platform
Keywords: islo,sdk,sandbox,ai-agents,api-client
Author: Islo Labs
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: httpx>=0.21.2
Requires-Dist: pydantic>=1.9.2
Requires-Dist: typing-extensions>=4.0.0
Requires-Python: >=3.10
Project-URL: Homepage, https://islo.dev
Project-URL: Repository, https://github.com/islo-labs/islo-sdk
Project-URL: Documentation, https://docs.islo.dev
Project-URL: Issues, https://github.com/islo-labs/islo-sdk/issues
Description-Content-Type: text/markdown

# Islo Python Library

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fislo-labs%2Fpython-sdk)
[![pypi](https://img.shields.io/pypi/v/islo)](https://pypi.python.org/pypi/islo)

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

## Table of Contents

- [Installation](#installation)
- [Quick Start](#quick-start)
- [Authentication](#authentication)
- [Configuration](#configuration)
- [Async Support](#async-support)
- [Development](#development)
- [Reference](#reference)
- [Usage](#usage)
- [Async Client](#async-client)
- [Exception Handling](#exception-handling)
- [Advanced](#advanced)
  - [Access Raw Response Data](#access-raw-response-data)
  - [Retries](#retries)
  - [Timeouts](#timeouts)
  - [Custom Client](#custom-client)
- [Contributing](#contributing)

## Installation

```sh
pip install islo
```

## Quick Start

```python
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)

```bash
export ISLO_API_KEY="your-api-key"
```

```python
client = Islo()  # Picks up ISLO_API_KEY automatically
```

### Explicit token

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

### Auto-refreshing token provider

```python
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

```python
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

```bash
# 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](https://buildwithfern.com/) from the OpenAPI spec maintained in [`islo-web-api`](https://github.com/islo-labs/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](https://github.com/islo-labs/python-sdk/blob/HEAD/./reference.md).

## Usage

Instantiate and use the client with the following:

```python
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).

```python
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.

```python
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.

```python
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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)

Use the `max_retries` request option to configure this behavior.

```python
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.

```python
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.

```python
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!
