porter-sandbox
Python SDK for the Porter Sandbox API.
Pre-release. Pilot for Porter's multi-language SDK rollout.
Install
pip install porter-sandbox
Usage
from porter_sandbox import Porter
with Porter() as porter:
sb = porter.sandboxes.create(
image="python:3.11-alpine",
command=["python", "-c", "print('hi')"],
)
print(sb.logs())
sb.terminate()
Volumes can be created up front and mounted into sandboxes at launch, and their contents browsed and read straight from the volume handle:
volume = porter.volumes.create(name="my-data")
sb = porter.sandboxes.create(
image="python:3.11-alpine",
volume_mounts={"/mnt/my-data": volume.id},
)
for file in volume.listdir("/checkpoints"):
print(file.path, file.size_bytes)
config = volume.read_text("/checkpoints/config.json")
with open("model.safetensors", "wb") as out:
for chunk in volume.stream("/checkpoints/model.safetensors"):
out.write(chunk)
Inside a sandbox-enabled Porter cluster, the SDK connects to the in-cluster
sandbox API at http://sandbox-api.porter-sandbox-system.svc.cluster.local:8080
automatically, with no configuration needed.
From outside the cluster, set a Porter API token (created from Settings > API tokens in the Porter Dashboard) and the cluster where sandboxes are enabled:
export PORTER_SANDBOX_API_KEY=<porter-api-token>
export PORTER_CLUSTER_ID=<cluster-id>
The SDK reads the project from the token and calls the sandbox API through the
Porter API at dashboard.porter.run. To target a specific URL instead, set
PORTER_SANDBOX_BASE_URL or pass base_url - both take precedence over
everything above.
Async
For async code (FastAPI handlers, concurrent sandbox fan-out, etc.) use AsyncPorter — same surface, awaitable methods:
import asyncio
from porter_sandbox import AsyncPorter
async def main():
async with AsyncPorter() as porter:
sb = await porter.sandboxes.create(image="python:3.11-alpine", command=["python", "-c", "print('hi')"])
print(await sb.logs())
await sb.terminate()
asyncio.run(main())
Async is also the right choice when launching many sandboxes in parallel:
async with AsyncPorter() as porter:
results = await asyncio.gather(*[
porter.sandboxes.create(image="python:3.11", command=cmd) for cmd in commands
])
Layout
Everything under porter_sandbox/ is generated from the Porter Sandbox OpenAPI
spec. Do not edit it by hand - changes there are overwritten on the next release.
porter_sandbox/sandbox.py,porter_sandbox/volume.py- sync and asyncSandboxandVolumehandlesporter_sandbox/porter.pyand resource namespace modules likeporter_sandbox/sandboxes.py- public client and namespacesporter_sandbox/_client.py,_models.py,enums.py,_errors.py,resources/- low-level client, models, and errorsporter_sandbox/_base_client.py,_async_base_client.py,_config.py,_retries.py- sync and async HTTP transports, env-var resolution, retry/backoff
Development
pip install -e ".[dev]"
pytest
ruff check .
mypy
Metadata
Release files for porter-sandbox 0.1.68
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| porter_sandbox-0.1.68.tar.gz | 73.6 kB | With provenance | Details for porter_sandbox-0.1.68.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| porter_sandbox-0.1.68-py3-none-any.whl | Python 3 | none | any | Details for porter_sandbox-0.1.68-py3-none-any.whl |
Total release size: 115.0 kB
Release files / porter_sandbox-0.1.68.tar.gz
| Download URL | porter_sandbox-0.1.68.tar.gz |
|---|---|
| Size | 73.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7075c685cd3d9b2786f033ffcf35afc33a98eda5dc8ead5edd1bd69b320cb008
|
|
BLAKE2b-256 checksum How to use checksums |
aa2353836c6bcd34c0de0ff69ef16ddc0c1a68193333f731d4b7a37ec87d2f7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logRelease files / porter_sandbox-0.1.68-py3-none-any.whl
| Download URL | porter_sandbox-0.1.68-py3-none-any.whl |
|---|---|
| Size | 41.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58de78015dc4b6447ba7accd26281a18d98238eb8db438b060df9889a7757006
|
|
BLAKE2b-256 checksum How to use checksums |
d8a8815b6f7a4ceaf9e2947e15bb18a46a79974989764427b7333a68d0de57a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logSecurity for porter-sandbox 0.1.68
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for porter_sandbox-0.1.68.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.