Metadata-Version: 2.4
Name: mimiry-sdk
Version: 0.5.0
Summary: The Mimiry SDK for Python: the Go SDK's client and the mimiry command, in one wheel
Author: Mimiry ApS
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Project-URL: Homepage, https://github.com/mimiry-com/mimiry-sdk-python
Project-URL: Source, https://github.com/mimiry-com/mimiry-sdk-python
Project-URL: Go SDK, https://github.com/mimiry-com/mimiry-sdk
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# mimiry-sdk

The Mimiry SDK for Python. Most people install [`mimiry`](https://pypi.org/project/mimiry/), which
installs this.

```
pip install mimiry
```

Each wheel carries the [Go SDK](https://github.com/mimiry-com/mimiry-sdk)'s `mimiry` binary of the
same version. So you get two things:

- **The `mimiry` command.** It is the Go CLI itself: `mimiry auth`, `mimiry availability`,
  `mimiry session create`, and the rest. `mimiry --help` lists them.
- **The `mimiry` Python module.** Every call goes through the binary's machine interface,
  `mimiry rpc`, so it behaves exactly as Go and the command do.

```python
import mimiry

c = mimiry.Client(host="platform", key="~/.ssh/id_ed25519")
print(c.account.balance().available)

for s in c.sessions.list(state=["running"], all=True):
    print(s.id, s.status)
```

`host` and `key` may be left out. Then `MIMIRY_HOST` and `MIMIRY_SSH_KEY` are used, then what
`mimiry auth` saved. A key that needs a passphrase must be loaded in ssh-agent.

- **Results** read as attributes (`s.status`) or items (`s["status"]`). A list answers a `Page`:
  `items`, `total_count`, `limit`, `offset` and `unavailable`, and iterating it iterates its items.
  `all=True` reads every page.
- **Errors** are one class per kind, all subclasses of `mimiry.MimiryError`. An `APIError`
  carries the API's `code` (e.g. `insufficient_balance`) and `status`.
- **Waits** (`sessions.wait_ready`, `volumes.wait_provisioned`, `orgs.wait_operation`) have no
  bound unless you pass `timeout`.

Linux (amd64, arm64) and macOS 13 or later (Intel, Apple silicon). Python 3.11 or later.

Copyright 2026 Mimiry ApS. Apache-2.0.
