Metadata-Version: 2.4
Name: docker-sbx-api
Version: 0.36.0rc1
Summary: Generated Python SDK for the Docker Sandboxes API
Author: Docker, Inc.
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/docker/sandboxes-api
Project-URL: Documentation, https://docs.docker.com/ai/sandboxes/
Project-URL: Source, https://github.com/docker/sandboxes-api
Keywords: docker,sandboxes,connectrpc,protobuf
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: connectrpc==0.10.1
Requires-Dist: protobuf==7.35.1
Requires-Dist: googleapis-common-protos>=1.63

# docker-sbx-api

Generated Python SDK for the [Docker Sandboxes API](https://github.com/docker/sandboxes-api).
One contract, served by local `sandboxd` and by the cloud sandbox API.

```sh
pip install docker-sbx-api
```

```python
import sbx_facade

client = sbx_facade.connect("https://api.sandboxes.docker.com")
```

Management services live under `docker.sbx.v1`. Process and file services live
under `docker.sbx.process.v1` and `docker.sbx.files.v1` and are reached through a
running sandbox's own endpoint rather than the management endpoint. Call
`CapabilityService.GetCapabilities` to discover what the backend you are talking
to serves. An RPC a backend does not serve raises `ConnectError(UNIMPLEMENTED)`.

This package installs alongside `docker` (the Docker Engine SDK). It contributes
`docker.sbx` as a namespace subpackage and adds no `docker/__init__.py`, so the
two coexist in either install order.

Contract reference, decision log and examples in all three languages:
<https://github.com/docker/sandboxes-api>.
