Metadata-Version: 2.5
Name: numen-sandbox-py
Version: 0.27.0
Summary: Python client for the Numen sandbox API
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Requires-Dist: grpcio>=1.70.0
Requires-Dist: protobuf>=7.36.2
Description-Content-Type: text/markdown

# numen-sandbox-py

Python client for the Numen sandbox API.

This is a **0.x** release. Breaking changes can still ship in any version until 1.0.

## Install

```bash
pip install numen-sandbox-py
```

## Credentials

By default the client reads `~/.config/numen/credentials.json`:

```json
{
  "client_id": "pcc_...",
  "client_secret": "..."
}
```

Pass `credentials_file` to use a different file. `~` is expanded.

## Quickstart

`image` is required. `numen/base` is the general platform image. The `with` block deletes the sandbox when the block ends.

```python
from numen_sandbox_py import Client, Sandbox

with Client() as c, Sandbox.create(c, image="numen/base") as sb:
    result = sb.run(["python", "-c", "print(2+2)"])
    print(result.stdout)
```

Guides and the method reference are in the portal: [Getting started](https://numen.keska.io/documentation/getting-started) and [SDK](https://numen.keska.io/documentation/sdk).
