Remote Box
Type-safe remote Python function execution framework with multiple backend support.
Installation
uv add remote-box
Quick Start
Execute Python functions on remote machines with type safety:
from pathlib import Path
from pydantic import BaseModel
from remote import remote, E2B
class Input(BaseModel):
name: str
class Output(BaseModel):
greeting: str
@remote(
local_project_root=Path(__file__).parent,
backend=E2B(
template_prefix="my-project"
)
)
async def greet(input: Input) -> Output:
# This code runs on a remote E2B sandbox!
return Output(greeting=f"Hello {input.name}!")
# Usage
result = await greet(Input(name="World"))
print(result.greeting) # "Hello World!"
The first call builds the sandbox image from your Dockerfile automatically (see
Building images to move that into CI/CD instead of dynamically at runtime).
Features
- Type-safe: Inputs/outputs validated using Pydantic models; arguments travel as JSON, so
datetime, enums, and nested models all work - Reusable sandboxes:
RemoteSessionruns consecutive calls in the same sandbox — write a file in one call, read it in the next - Agent-framework ready: explicit
start/pause/resume/closelifecycle with serializable session refs, so sandboxes can survive agent idle periods and process restarts - Multiple backends:
- Async-first: Built on asyncio for high performance
- No import-time side effects: images build lazily on first call, or explicitly via the
remote-box buildCLI (recommended for production) - Real remote errors: exceptions raised remotely surface locally as
RemoteExecutionErrorwith the remote traceback attached
Sessions: consecutive calls in one sandbox
By default every call gets a fresh sandbox that is destroyed afterwards. To share
one sandbox (and its filesystem) across calls, run them inside a RemoteSession
scope — calls pick the session up implicitly:
from remote import RemoteSession, Daytona
async with RemoteSession(
backend=Daytona(snapshot_name="my-project"),
local_project_root=Path(__file__).parent,
):
await write_file(WriteInput(path="/tmp/state.json", data="..."))
result = await read_file(ReadInput(path="/tmp/state.json"))
# sandbox destroyed on exit
There is deliberately no session= parameter on decorated functions: their
signature is exactly the input model, so frameworks that reflect tool signatures
(e.g. AI agent SDKs building tool schemas) never see session plumbing. Session
propagation uses a context variable, which flows correctly across await
boundaries and into asyncio.create_task.
Notes:
- The session's backend config decides where the code runs; the decorator's own backend is only used for session-less calls.
- Calls within a session are serialized with an internal lock, so sharing a session between concurrent tasks is safe (they just won't run in parallel).
- In notebooks,
async withworks at the top level, or useawait session.start()/await session.close()explicitly. - E2B sandboxes have a lifetime TTL (
sandbox_ttl_seconds, default 600s) that is refreshed before every call, so a session stays alive as long as you keep using it.
Explicitly managing sandbox lifecycles: start, pause, resume, close
async with on a session that was not explicitly started owns the sandbox: it
is created on entry and destroyed on exit (the example above). If the session was
already started with await session.start(), async with only activates it for
the scope — whoever started it decides when it dies. This lets a framework (e.g.
an AI agent runtime that auto-sandboxes tools) manage one sandbox across many tool
calls:
session = RemoteSession(backend=Daytona(...), local_project_root=...)
await session.start() # framework owns the sandbox
async with session: # per tool call — activates, doesn't destroy
result = await some_tool(input) # session picked up implicitly
ref = await session.pause() # agent idles (e.g. waiting on human input):
# sandbox stops consuming compute
async with session: # transparently resumes the paused sandbox
result = await another_tool(input)
await session.close() # only at agent termination
pause() returns a SessionRef — a small, secret-free, JSON-serializable pointer
to the sandbox (session.ref works any time after start). Persist it anywhere and
reattach later, even from a different process:
# process A
ref_json = (await session.pause()).model_dump_json()
# process B, an hour later
session = await RemoteSession.resume(
SessionRef.model_validate_json(ref_json),
backend=Daytona(...), # refs carry no credentials — config is re-supplied
local_project_root=...,
)
async with session:
result = await next_tool(input)
Pause/resume semantics per backend — declared upfront by the config, queryable
via session.pause_semantics (a PauseSemantics enum) before the session even
starts:
| Backend | pause_semantics |
pause() does |
Preserved | Cross-process resume |
|---|---|---|---|---|
Daytona (sandbox_class="linux-vm") |
SUSPEND |
native pause | filesystem and memory — running processes survive | client.get(id) + start |
Daytona (sandbox_class="container", default) |
STOP |
stop | filesystem only — processes are killed | client.get(id) + start |
| E2B | SUSPEND |
native sandbox pause | filesystem and memory | AsyncSandbox.connect(id) |
| Subprocess | NOOP |
nothing | local filesystem trivially | fresh handle |
If your agents leave background processes running across a pause (a dev server,
a long build), use Daytona's sandbox_class="linux-vm" (or E2B). The class is
baked into the snapshot at build time and included in its name, so switching
class builds a new snapshot. Not every Daytona region/organization has
linux-vm runners — if yours doesn't, the snapshot build fails upfront with an
actionable error (set region_id to a region that offers it, or ask Daytona to
enable it for your organization).
Prefer pausing at genuine idle points rather than after every call — a pause/resume round trip costs a few seconds on the cloud backends. Daytona users can also set an auto-pause interval on the platform side as a safety net.
Building a sandboxed tool decorator on top of remote-box
Agent frameworks generally want to own their own @tool decorator end to
end — the user should write @tool(sandboxed=True) and nothing else; the
framework decides internally that "sandboxed" means "run this on remote-box"
without ever asking its users to import or apply @remote themselves. A
typical @tool also runs its own logic before the tool body — a
human-approval gate, a rate limiter, a log line — which creates one hazard
that remote-box exposes a public hook for.
A @remote-decorated call doesn't invoke the original function object
remotely — it generates a small script that re-imports the target module by
name inside the sandbox and calls whatever's bound to that name there. Since
@tool applies @remote to the function internally, that name is @tool's
own wrapper, so the sandbox's fresh re-import re-runs @tool's wrapper too —
including the approval gate — a second time, remotely, where it can't
reach a human and shouldn't run again regardless.
in_remote_execution() is the same check @remote uses internally to skip
straight to the wrapped function instead of recursing into another sandbox
dispatch. @tool should do the identical thing at the very top of its own
wrapper, before its gating logic runs — and once it does, it can call the
raw undecorated function directly, skipping the @remote machinery
entirely on that path:
import functools
from pathlib import Path
from remote import remote, in_remote_execution, Daytona
def tool(sandboxed: bool = False):
def decorator(raw_func):
# The user never sees or applies @remote — "sandboxed" is an internal
# detail of what this framework's @tool decorator does.
dispatch = (
remote(local_project_root=Path.cwd(), backend=Daytona(snapshot_name="my-agent"))(raw_func)
if sandboxed
else raw_func
)
@functools.wraps(raw_func)
async def wrapper(arg):
if in_remote_execution():
# Already inside the sandbox: the gate below already ran once
# on the host before @remote ever dispatched here, so run the
# real body directly — no gate, no re-dispatch.
return await raw_func(arg)
if sandboxed:
await request_human_approval(arg)
return await dispatch(arg)
return wrapper
return decorator
@tool(sandboxed=True)
async def delete_file(input: DeleteInput) -> DeleteResult: ...
The end user's function is decorated exactly once, with the framework's own
decorator; remote-box never appears in their code. Every framework that
wraps @remote this way just needs its @tool wrapper to check
in_remote_execution() first — the check composes regardless of how many
such frameworks end up in the same call stack, since each one independently
falls straight through to its inner function on the remote side.
Building images: local dev vs CI/CD
E2B templates and Daytona snapshots are built from your Dockerfile and cached
under the name {prefix}-{context_hash}; Daytona snapshots additionally append
-{sandbox_class}, since the class is baked into the snapshot. The hash covers
the entire build context — every file under local_project_root that your
.dockerignore doesn't exclude, plus the Dockerfile itself — so editing
anything the image could contain automatically produces a new image name and
triggers a fresh build. There is no version to bump and no pyproject.toml
requirement; staleness is simply impossible.
Notes on the context hash:
.dockerignoreis honored with Docker's semantics (root-anchored patterns,**globs,!negations, last match wins). A tight.dockerignoreis doubly worthwhile: smaller build contexts and fewer spurious rebuilds from files your image never contains.- VCS internals, caches, and virtualenvs (
.git,__pycache__,.venv,node_modules, etc.) are always excluded from the hash, even without a.dockerignore— otherwise every commit or test run would look like a source change. - Want a human-readable marker (a version, an environment) in image names on your E2B/Daytona dashboard? Just put it in the prefix itself.
Whether a missing image may be built lazily at runtime is controlled by the
REMOTE_BOX_AUTO_BUILD environment variable (default: true), so switching
between local dev and production requires no source changes no matter how many
@remote functions you have:
-
Local dev / notebooks (default) — leave
REMOTE_BOX_AUTO_BUILDunset: the first call that needs a missing image builds it on the spot. -
Production (recommended) — set
REMOTE_BOX_AUTO_BUILD=falsein the deployment environment and build ahead of time in CI/CD with the CLI:remote-box build src/ # directory: crawls *.py recursively remote-box build src/my_tasks.py # single file remote-box build myproject.tasks # dotted module name remote-box build src/ --env-file .env.local # custom env file for API keys remote-box build src/ --check # discovery only: report, build nothing
The CLI imports the target(s), finds every
@remote-decorated function, and builds any missing images (the env var does not apply to the CLI — explicit builds always build). At runtime, a missing image then raisesMissingImageErrorinstead of paying the build cost (or requiring build permissions) in production.Directory crawls skip hidden, venv, and cache directories, and a file that fails to import fails the run (exit 1) after building everything that did import — a broken file might contain
@remotefunctions, so CI must not pass silently. API keys load from.envautomatically; use--env-filefor an alternate file like.env.local.--checkruns discovery only and reports each target as[ready],[would build](image missing), or[error](bad config/credentials) without building anything. It exits 0 only when everything is ready, so a deploy pipeline can gate on it: build images in CI, then--checkas a pre-deploy verification that nothing slipped through. Also available programmatically asremote.runtime.check_all().The same thing is available programmatically via
remote.build_all()after importing your task modules.
For the rare case where one specific config must pin its behavior regardless of
the environment, set auto_build_override=True/False on that config — it takes
precedence over the env var, but it means editing source to change environments,
so prefer the env var.
Backends
E2B (Production)
Execute code on remote secure sandboxes via E2B.
from remote import remote, E2B
@remote(
local_project_root=Path(__file__).parent,
backend=E2B(
template_prefix="my-project", # template name becomes "my-project-{context_hash}"
e2b_api_key="...", # or set E2B_API_KEY env var
cpu_count=2,
memory_mb=2048,
)
)
async def my_func(input: Input) -> Output: ...
Daytona (Production)
Execute code on remote sandboxes via Daytona.
from remote import remote, Daytona
@remote(
local_project_root=Path(__file__).parent,
backend=Daytona(
snapshot_name="my-project", # snapshot name becomes "my-project-{context_hash}"
daytona_api_key="...", # or set DAYTONA_API_KEY env var
cpu_count=2,
memory_gb=2,
disk_gb=5,
)
)
async def my_func(input: Input) -> Output: ...
Subprocess (Development)
Execute code in a local subprocess via uv run (requires bash and uv). Ideal
for development and testing — no API keys or Docker required.
from remote import remote, Subprocess
@remote(
local_project_root=Path(__file__).parent,
backend=Subprocess()
)
async def my_func(input: Input) -> Output: ...
Error handling
from remote import RemoteExecutionError, RemoteExecutionProtocolError, MissingImageError
try:
result = await my_func(Input(...))
except RemoteExecutionError as e:
print(e.error_type) # e.g. "ValueError" — exception type raised remotely
print(e.error_message)
print(e.remote_traceback) # full remote traceback
RemoteExecutionError— your function raised an exception remotelyRemoteExecutionProtocolError— the sandbox response couldn't be parsed at all (carriesraw_outputfor debugging); interpreter-level failures (import errors, crashes) surface the remote stderr in the raised errorMissingImageError— auto-building is disabled (REMOTE_BOX_AUTO_BUILD=false) and the image hasn't been built yet
Configuration Reference
remote decorator
| Parameter | Type | Default | Description |
|---|---|---|---|
local_project_root |
Path |
required | Root directory used to resolve imports, locate the Dockerfile, and define the build context that gets hashed |
backend |
AnyBackendConfig |
Subprocess() |
Backend to execute on |
timeout_millis |
int |
300000 |
Max execution time in ms (default 5 minutes) |
RemoteSession
| Parameter | Type | Default | Description |
|---|---|---|---|
backend |
AnyBackendConfig |
required | Backend for the shared sandbox |
local_project_root |
Path |
required | Root directory of the project |
timeout_millis |
int |
300000 |
Default per-call timeout |
Lifecycle API: await start(), async with session: (activates; owns the sandbox
only if it wasn't started explicitly), await pause() -> SessionRef, session.ref,
classmethod await RemoteSession.resume(ref, backend=..., local_project_root=...),
await close().
E2B config
| Parameter | Default | Description |
|---|---|---|
template_prefix |
required | Prefix for E2B template name ({prefix}-{context_hash}) |
e2b_api_key |
None |
API key (falls back to E2B_API_KEY env var) |
dockerfile_path |
None |
Path to Dockerfile; defaults to Dockerfile in project root |
cpu_count |
1 |
CPUs to allocate |
memory_mb |
1024 |
Memory in MB to allocate |
auto_build_override |
None |
Pin auto-build for this config, overriding REMOTE_BOX_AUTO_BUILD; prefer leaving unset |
sandbox_ttl_seconds |
600 |
Sandbox lifetime, refreshed before every call |
env_vars |
{} |
Environment variables injected into the sandbox at creation (per-sandbox, not baked into the template). Inherited by every command started afterwards, including the root commands the backend runs |
start_cmd |
None |
Long-running command baked into the template, launched once at build time; the VM is snapshotted with it running, so every sandbox resumes with it alive. Does not keep the sandbox alive (E2B owns lifetime), runs as the unprivileged default user, and cannot see env_vars (it starts before any sandbox exists) |
start_ready_cmd |
None |
Shell command E2B polls until it exits 0 before finalizing the template build, so nothing is snapshotted mid-startup. Ignored unless start_cmd is set; defaults to a fixed 1s wait |
post_create_cmd |
None |
Command fired once per sandbox right after creation, as root and in the background — the hook for per-sandbox credentials, since it does see env_vars. Not waited on (poll if you need it ready), never fatal, and not fired on reconnect/resume |
allow_public_traffic |
True |
Whether the sandbox's URLs are reachable by anyone who knows them. False makes E2B issue a traffic access token that callers must present; reconnecting to the sandbox by ID recovers the same token, so a preview proxy can authenticate upstream. Per-sandbox, not baked into the template |
Getting a credential into a sandbox: mint it per sandbox, pass it in env_vars,
and consume it from post_create_cmd. start_cmd cannot do this — E2B runs it
once while the template builds and snapshots the VM with the process already
running, so it starts before any sandbox (or its env_vars) exists. A Dockerfile
CMD/ENTRYPOINT cannot either: E2B's from_dockerfile translates it into that
same build-time start command, and this backend then overrides it — so a CMD in
your Dockerfile is silently ignored, and start_cmd is the only way to bake in a
boot process.
Daytona config
| Parameter | Default | Description |
|---|---|---|
snapshot_name |
required | Prefix for Daytona snapshot name ({name}-{context_hash}-{sandbox_class}) |
daytona_api_key |
None |
API key (falls back to DAYTONA_API_KEY env var) |
dockerfile_path |
None |
Path to Dockerfile; defaults to Dockerfile in project root |
sandbox_class |
"container" |
Daytona sandbox class. "linux-vm" enables true pause (processes survive); "container" pauses by stopping (disk only) |
region_id |
None |
Daytona region for the snapshot and sandboxes; defaults to the org's default region. Class availability varies by region |
cpu_count |
1 |
CPUs to allocate |
memory_gb |
1 |
Memory in GB to allocate (per-class minimums validated at config time) |
disk_gb |
3 |
Disk in GB to allocate (linux-vm requires ≥ 3) |
auto_build_override |
None |
Pin auto-build for this config, overriding REMOTE_BOX_AUTO_BUILD; prefer leaving unset |
create_timeout_seconds |
120 |
Max time to wait for sandbox creation |
env_vars |
{} |
Environment variables injected into the sandbox at creation (per-sandbox, not baked into the snapshot) |
Subprocess config
No parameters. Runs locally via bash + uv run (both must be on PATH).
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file remote_box-0.10.0.tar.gz.
File metadata
- Download URL: remote_box-0.10.0.tar.gz
- Upload date:
- Size: 149.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea43be9c63b930d55f154f1ff1a0751ee5b26994ca1cd65c4121098ae1f4f4bd
|
|
| MD5 |
0cd88dc716adebcaf42ca40390ed3c81
|
|
| BLAKE2b-256 |
201a34d394670f76c2cc4a056f824fa594bc87ff0105b282ff22238a4e8026e7
|
Provenance
The following attestation bundles were made for remote_box-0.10.0.tar.gz:
Publisher:
release.yml on JasonSteving99/remote-box
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
remote_box-0.10.0.tar.gz -
Subject digest:
ea43be9c63b930d55f154f1ff1a0751ee5b26994ca1cd65c4121098ae1f4f4bd - Sigstore transparency entry: 2285333821
- Sigstore integration time:
-
Permalink:
JasonSteving99/remote-box@4a8d4c3c9f14dd16cfc4af0cacdac47500db5525 -
Branch / Tag:
refs/tags/0.10.0 - Owner: https://github.com/JasonSteving99
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4a8d4c3c9f14dd16cfc4af0cacdac47500db5525 -
Trigger Event:
release
-
Statement type:
File details
Details for the file remote_box-0.10.0-py3-none-any.whl.
File metadata
- Download URL: remote_box-0.10.0-py3-none-any.whl
- Upload date:
- Size: 41.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
20084d4dfae155b6eee65055ef35c2adbe2615499ab595c62a2bf8b28712ffc4
|
|
| MD5 |
96b8511dd95a3949e0185fe460624340
|
|
| BLAKE2b-256 |
6c1d074023309d5b39e632d026857054e3d5bc2a351b5c16db83ab1a0eb44e40
|
Provenance
The following attestation bundles were made for remote_box-0.10.0-py3-none-any.whl:
Publisher:
release.yml on JasonSteving99/remote-box
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
remote_box-0.10.0-py3-none-any.whl -
Subject digest:
20084d4dfae155b6eee65055ef35c2adbe2615499ab595c62a2bf8b28712ffc4 - Sigstore transparency entry: 2285333923
- Sigstore integration time:
-
Permalink:
JasonSteving99/remote-box@4a8d4c3c9f14dd16cfc4af0cacdac47500db5525 -
Branch / Tag:
refs/tags/0.10.0 - Owner: https://github.com/JasonSteving99
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4a8d4c3c9f14dd16cfc4af0cacdac47500db5525 -
Trigger Event:
release
-
Statement type: