Metadata-Version: 2.3
Name: rmote
Version: 0.7.2
Summary: Run Python tools on remote hosts over SSH or subprocess streams.
License: 
                                          Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         
            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
         
            1. Definitions.
         
               "License" shall mean the terms and conditions for use, reproduction,
               and distribution as defined by Sections 1 through 9 of this document.
         
               "Licensor" shall mean the copyright owner or entity authorized by
               the copyright owner that is granting the License.
         
               "Legal Entity" shall mean the union of the acting entity and all
               other entities that control, are controlled by, or are under common
               control with that entity. For the purposes of this definition,
               "control" means (i) the power, direct or indirect, to cause the
               direction or management of such entity, whether by contract or
               otherwise, or (ii) ownership of fifty percent (50%) or more of the
               outstanding shares, or (iii) beneficial ownership of such entity.
         
               "You" (or "Your") shall mean an individual or Legal Entity
               exercising permissions granted by this License.
         
               "Source" form shall mean the preferred form for making modifications,
               including but not limited to software source code, documentation
               source, and configuration files.
         
               "Object" form shall mean any form resulting from mechanical
               transformation or translation of a Source form, including but
               not limited to compiled object code, generated documentation,
               and conversions to other media types.
         
               "Work" shall mean the work of authorship, whether in Source or
               Object form, made available under the License, as indicated by a
               copyright notice that is included in or attached to the work
               (an example is provided in the Appendix below).
         
               "Derivative Works" shall mean any work, whether in Source or Object
               form, that is based on (or derived from) the Work and for which the
               editorial revisions, annotations, elaborations, or other modifications
               represent, as a whole, an original work of authorship. For the purposes
               of this License, Derivative Works shall not include works that remain
               separable from, or merely link (or bind by name) to the interfaces of,
               the Work and Derivative Works thereof.
         
               "Contribution" shall mean any work of authorship, including
               the original version of the Work and any modifications or additions
               to that Work or Derivative Works thereof, that is intentionally
               submitted to Licensor for inclusion in the Work by the copyright owner
               or by an individual or Legal Entity authorized to submit on behalf of
               the copyright owner. For the purposes of this definition, "submitted"
               means any form of electronic, verbal, or written communication sent
               to the Licensor or its representatives, including but not limited to
               communication on electronic mailing lists, source code control systems,
               and issue tracking systems that are managed by, or on behalf of, the
               Licensor for the purpose of discussing and improving the Work, but
               excluding communication that is conspicuously marked or otherwise
               designated in writing by the copyright owner as "Not a Contribution."
         
               "Contributor" shall mean Licensor and any individual or Legal Entity
               on behalf of whom a Contribution has been received by Licensor and
               subsequently incorporated within the Work.
         
            2. Grant of Copyright License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               copyright license to reproduce, prepare Derivative Works of,
               publicly display, publicly perform, sublicense, and distribute the
               Work and such Derivative Works in Source or Object form.
         
            3. Grant of Patent License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               (except as stated in this section) patent license to make, have made,
               use, offer to sell, sell, import, and otherwise transfer the Work,
               where such license applies only to those patent claims licensable
               by such Contributor that are necessarily infringed by their
               Contribution(s) alone or by combination of their Contribution(s)
               with the Work to which such Contribution(s) was submitted. If You
               institute patent litigation against any entity (including a
               cross-claim or counterclaim in a lawsuit) alleging that the Work
               or a Contribution incorporated within the Work constitutes direct
               or contributory patent infringement, then any patent licenses
               granted to You under this License for that Work shall terminate
               as of the date such litigation is filed.
         
            4. Redistribution. You may reproduce and distribute copies of the
               Work or Derivative Works thereof in any medium, with or without
               modifications, and in Source or Object form, provided that You
               meet the following conditions:
         
               (a) You must give any other recipients of the Work or
                   Derivative Works a copy of this License; and
         
               (b) You must cause any modified files to carry prominent notices
                   stating that You changed the files; and
         
               (c) You must retain, in the Source form of any Derivative Works
                   that You distribute, all copyright, patent, trademark, and
                   attribution notices from the Source form of the Work,
                   excluding those notices that do not pertain to any part of
                   the Derivative Works; and
         
               (d) If the Work includes a "NOTICE" text file as part of its
                   distribution, then any Derivative Works that You distribute must
                   include a readable copy of the attribution notices contained
                   within such NOTICE file, excluding those notices that do not
                   pertain to any part of the Derivative Works, in at least one
                   of the following places: within a NOTICE text file distributed
                   as part of the Derivative Works; within the Source form or
                   documentation, if provided along with the Derivative Works; or,
                   within a display generated by the Derivative Works, if and
                   wherever such third-party notices normally appear. The contents
                   of the NOTICE file are for informational purposes only and
                   do not modify the License. You may add Your own attribution
                   notices within Derivative Works that You distribute, alongside
                   or as an addendum to the NOTICE text from the Work, provided
                   that such additional attribution notices cannot be construed
                   as modifying the License.
         
               You may add Your own copyright statement to Your modifications and
               may provide additional or different license terms and conditions
               for use, reproduction, or distribution of Your modifications, or
               for any such Derivative Works as a whole, provided Your use,
               reproduction, and distribution of the Work otherwise complies with
               the conditions stated in this License.
         
            5. Submission of Contributions. Unless You explicitly state otherwise,
               any Contribution intentionally submitted for inclusion in the Work
               by You to the Licensor shall be under the terms and conditions of
               this License, without any additional terms or conditions.
               Notwithstanding the above, nothing herein shall supersede or modify
               the terms of any separate license agreement you may have executed
               with Licensor regarding such Contributions.
         
            6. Trademarks. This License does not grant permission to use the trade
               names, trademarks, service marks, or product names of the Licensor,
               except as required for reasonable and customary use in describing the
               origin of the Work and reproducing the content of the NOTICE file.
         
            7. Disclaimer of Warranty. Unless required by applicable law or
               agreed to in writing, Licensor provides the Work (and each
               Contributor provides its Contributions) on an "AS IS" BASIS,
               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
               implied, including, without limitation, any warranties or conditions
               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
               PARTICULAR PURPOSE. You are solely responsible for determining the
               appropriateness of using or redistributing the Work and assume any
               risks associated with Your exercise of permissions under this License.
         
            8. Limitation of Liability. In no event and under no legal theory,
               whether in tort (including negligence), contract, or otherwise,
               unless required by applicable law (such as deliberate and grossly
               negligent acts) or agreed to in writing, shall any Contributor be
               liable to You for damages, including any direct, indirect, special,
               incidental, or consequential damages of any character arising as a
               result of this License or out of the use or inability to use the
               Work (including but not limited to damages for loss of goodwill,
               work stoppage, computer failure or malfunction, or any and all
               other commercial damages or losses), even if such Contributor
               has been advised of the possibility of such damages.
         
            9. Accepting Warranty or Additional Liability. While redistributing
               the Work or Derivative Works thereof, You may choose to offer,
               and charge a fee for, acceptance of support, warranty, indemnity,
               or other liability obligations and/or rights consistent with this
               License. However, in accepting such obligations, You may act only
               on Your own behalf and on Your sole responsibility, not on behalf
               of any other Contributor, and only if You agree to indemnify,
               defend, and hold each Contributor harmless for any liability
               incurred by, or claims asserted against, such Contributor by reason
               of your accepting any such warranty or additional liability.
         
            END OF TERMS AND CONDITIONS
         
            APPENDIX: How to apply the Apache License to your work.
         
               To apply the Apache License to your work, attach the following
               boilerplate notice, with the fields enclosed by brackets "[]"
               replaced with your own identifying information. (Don't include
               the brackets!)  The text should be enclosed in the appropriate
               comment syntax for the file format. We also recommend that a
               file or class name and description of purpose be included on the
               same "printed page" as the copyright notice for easier
               identification within third-party archives.
         
            Copyright [yyyy] [name of copyright owner]
         
            Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
         
                http://www.apache.org/licenses/LICENSE-2.0
         
            Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Framework :: AsyncIO
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: System :: Distributed Computing
Classifier: Typing :: Typed
Classifier: Operating System :: POSIX
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.11
Project-URL: Homepage, https://github.com/mosquito/rmote
Project-URL: Repository, https://github.com/mosquito/rmote
Project-URL: Documentation, https://docs.rmote.org
Project-URL: Bug Tracker, https://github.com/mosquito/rmote/issues
Description-Content-Type: text/markdown

# rmote

![rmote](https://raw.githubusercontent.com/mosquito/rmote/master/docs/_static/logo.svg)

[![PyPI Version](https://img.shields.io/pypi/v/rmote.svg)](https://pypi.org/project/rmote/)
[![Python Versions](https://img.shields.io/pypi/pyversions/rmote.svg)](https://pypi.org/project/rmote/)
[![Tests](https://github.com/mosquito/rmote/actions/workflows/tests.yml/badge.svg)](https://github.com/mosquito/rmote/actions/workflows/tests.yml)
[![Docs](https://github.com/mosquito/rmote/actions/workflows/docs.yml/badge.svg)](https://docs.rmote.org)

rmote runs Python functions through SSH, `docker exec`, `kubectl exec`, or a
local Python subprocess. Any bidirectional stream that reaches a Python
interpreter can carry its protocol, including an appropriately connected `nc`
relay. See [Transports](https://docs.rmote.org/transports.html) for setup and examples.
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.

To connect without a remote agent, rmote launches standard `python3 -qui` on the target:

- `-q` (**quiet**): suppresses Python's startup banner and copyright messages.
- `-u` (**unbuffered**): forces unbuffered binary stdout/stderr so protocol frames flush immediately.
- `-i` (**interactive**): reads and executes statements from stdin even without a TTY.

## Install

```bash
python -m pip install rmote
```

Python 3.11 or newer is required locally too. Free-threaded builds work on
both sides, and the tests cover 3.13t and 3.14t. 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`:

<!-- name: test_readme; fixtures: docs_ssh; mark: timeout(20) -->
```python
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](https://docs.rmote.org/quickstart.html) 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.

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

`python -m rmote` accepts the same commands and options as `rmote`:
for example, `python -m rmote shell ssh server`. Run `rmote --help` to list
commands, or `rmote shell --help` for shell options.

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.

## Python REPL

Open a Python console with a ready connection and remote host facts:

```bash
rmote repl -- ssh -T server
rmote repl -- docker exec -i my-container
rmote repl --async -- ssh -T server
```

Use `host["system"]` to inspect the host, or
`remote(facts.gather, sections=["cpu", "memory"])` to collect more facts.
With `--async`, write `await remote(...)`. Built-in tools are imported and
you can define your own `Tool` in the console. See the
[REPL guide](https://docs.rmote.org/repl.html) for examples and script mode.

## Guides

- [Transports](https://docs.rmote.org/transports.html): SSH, Docker, Kubernetes, local Python and prepared byte streams.
- [Synchronization CLI](https://docs.rmote.org/rsync.html): `rmote rsync -r 'ssh -T host' ./source remote:/destination`, or the reverse direction.
- [Writing tools](https://docs.rmote.org/writing-tools.html): define a remote operation and return Python data.
- [Interactive shell](https://docs.rmote.org/shell.html): run a shell on a host through any transport command.
- [Multiple hosts](https://docs.rmote.org/multi-host.html): run operations concurrently and handle individual failures.
- [Templates](https://docs.rmote.org/templating.html): render configuration files.
- [Built-in tools](https://docs.rmote.org/api/tools/index.html): files, commands, packages, services, users, host facts, and logging.
- [Connection reference](https://docs.rmote.org/api/sync.html): SSH options, deadlines, and cleanup.
- [Execution model](https://docs.rmote.org/concepts.html): 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

```bash
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](https://docs.rmote.org/release-notes.html)
for changes and compatibility. Licensed under [Apache 2.0](LICENSE).

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`.
