rmote

rmote runs Python functions on another machine over SSH. Use its built-in tools to manage files, packages, and services, or write a tool for your application. Calls return Python values and propagate remote exceptions to the caller.

Install rmote on your local machine. The target needs Python 3.11 or newer, but no rmote installation or agent. Tool code is sent when it is first used on a connection.

Install

python -m pip install rmote

Python 3.11 or newer is required locally too. Package and service tools also need the target's system commands and sufficient permissions. rmote does not install tool dependencies or elevate privileges automatically.

Read a Remote File

Replace user@server with a host you can reach using your SSH configuration. Save this as read_hosts.py and run it with python read_hosts.py:

from rmote.sync import Connection
from rmote.tools import FileSystem

with Connection.from_ssh("user@server") as remote:
    hosts = remote(FileSystem.read_str, "/etc/hosts")
    assert "localhost" in hosts
    print(hosts, end="")

The file is read on the target, with the SSH user's permissions. The with block closes the connection. Connection.from_local() runs the same tools in a local subprocess; async applications use rmote.protocol.Protocol.

The quickstart walks through deploying Redis to a Docker container: install its package, render a systemd unit, start the service, and verify it. Switching to SSH changes only the connector.

Interactive Shell

rmote-shell opens an interactive shell on a host. The transport is any command that passes stdin and stdout through unchanged, so the same client reaches hosts over SSH, containers and pods.

rmote-shell ssh server
rmote-shell docker exec -i my-container
rmote-shell kubectl exec -i pod/my-pod --

The remote side opens a real pseudo terminal, so job control, full screen programs and window resizing all work. A redirected input or output uses pipes instead and keeps the bytes exactly. Press ~. after a line end to close the session.

Guides

• Writing tools: define a remote operation and return Python data.
• Interactive shell: run a shell on a host through any transport command.
• Multiple hosts: run operations concurrently and handle individual failures.
• Templates: render configuration files.
• Built-in tools: files, commands, packages, services, users, host facts, and logging.
• Connection reference: SSH options, deadlines, and cleanup.
• Execution model: code transfer, state, concurrency, and cancellation.

Use rmote only with trusted hosts and tool code. It transfers executable Python and uses pickle for results. A timeout stops local waiting; it does not cancel an operation already running on the target.

Development

uv sync --group dev --group docs
make test
make docs
make docs-test

Some integration tests require Docker; SSH tests need local OpenSSH binaries. Use uv run pytest --no-docker to exclude Docker tests. Named documentation examples run through markdown-pytest alongside the Python tests.

Tests are grouped by module: tests/protocol, tests/sync, tests/tools, tests/facts (including tests/facts/collectors), tests/cache, tests/immutable, tests/process, and tests/templates. Fixtures are scoped through local conftest.py files; shared implementations live in tests/support.

Run uv run pytest tests/cache to check the general cache, its JSON and SQLite backends, and serialization. uv run pytest tests/facts checks collection, result validation, and integration with the cache. For a local run of both areas, use uv run pytest tests/cache tests/facts --no-docker.

Collector integration tests use disposable Debian/systemd and Arch Docker containers, without an external SSH host. The systemd fixture uses Debian Forky for JSON-capable resolvectl status; package tests also cover Debian Trixie and Arch. The networkd/iproute2 tests also run on Ubuntu Noble, including managed DNS/NTP settings and cache refresh after networkd stops. Run uv run pytest tests/facts -m docker for those integration checks, or uv run pytest tests/facts --no-docker for local collection and parser tests. The systemd container needs privileged Docker with private network/cgroup namespaces; timesyncd stays masked so tests cannot change the host clock.

rmote is beta software. See the release notes for changes and compatibility. Licensed under Apache 2.0.

Documentation pages use MyST Markdown (.md) and are built with Sphinx. API pages include docstrings through autodoc in {eval-rst} blocks. Runnable Markdown examples are checked by markdown-pytest via make docs-test and the regular test suite. Both also run API doctests directly from the docstrings in rmote using pytest's --doctest-modules. To run only API doctests, use uv run pytest rmote.