Skip to main content

python API to execute asynchronous remote tasks with ssh

Project description

rcontrol Documentation Status

rcontrol is a python library based on paramiko intended to work with remote machines via ssh.

Unlike fabric, it is intended to perform tasks in an asynchronous way, and to work with python >= 2.7 (including python 3).

Please note that this is under development! I am waiting for feedback, ideas and contributors to make this tool evolve.

Basic example:

from rcontrol.ssh import SshSession, ssh_client
from rcontrol.core import SessionManager

def log(task, line):
    print("%r: %s" % (task, line))

with SessionManager() as sessions:
    # create sessions on two hosts
    sessions.bilbo = SshSession(
        ssh_client('', 'user', 'pwd'))
    sessions.nazgul = SshSession(
        ssh_client('', 'user', 'pwd'))

    # run commands in parallel
    sessions.bilbo.execute("uname -a && sleep 3", on_stdout=log)
    sessions.nazgul.execute("uname -a && sleep 3", on_stdout=log)

This example just show you how rcontrol looks like. Look at the documentation on if you’re interested to see more!

What rcontrol can do

  • execute multiple commands on local and remote hosts in an asynchronous way (it is up to you to synchronize them)
  • define timeout and output timeout for the commands
  • attach callbacks when a line is read (stdout or stderr), on timeout and when the commands are finished
  • copy files and directories from one host to another

What rcontrol needs (contributors, you’re welcome!)

  • be able to stop (kill) a command (local or remote)
  • more file operations
  • love

How to install

Use pip.

pip install -U rcontrol


See the CHANGELOG.rst file.

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
rcontrol-0.1.3.tar.gz (10.9 kB) Copy SHA256 hash SHA256 Source None Jun 16, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page