Skip to main content

Interact with shell locally or over different connection types (telnet, ssh, serial, adb)

Project description

citizenshell is a python library allowing to execute shell commands either locally or remotely over several protocols (telnet, ssh, serial or adb) using a simple and consistent API. This library is compatible with both python 2 (2.7) and 3 (>=3.4) as well as with PyPy. For now, it focuses on POSIX platforms like Linux and MacOS, but may be extended to work to Windows based platform in the future. It is distributed under MIT license.


citizenshell can simply installed using pip install citizenshell

Obtaining a shell

First you need a shell. For that you have several options:

  1. use the built-in LocalShell for quick access:

    from citizenshell import sh
  2. you can instanciate your own LocalShell:

    from citizenshell import LocalShell
    shell = LocalShell()
  3. you can instanciate the TelnetShell for shell over telnet:

    from citizenshell import TelnetShell
    shell = TelnetShell(hostname="", username="john",
  4. you can instanciate the SecureShell for shell over SSH:

    from citizenshell import SecureShell
    shell = SecureShell(hostname="", username="john",
  5. you can instanciate the AdbShell for shell over ADB:

    from citizenshell import AdbShell
    shell = AdbShell(hostname="", username="john",
  6. you can instanciate the SerialShell for shell over serial line:

    from serial import EIGHTBITS, PARITY_NONE
    from citizenshell import SerialShell
    shell = SerialShell(port="/dev/ttyUSB3", username="john",
                        baudrate=115200, parity=PARITY_NONE, bytesize=EIGHTBITS)
  7. you can also obtain shell objects by URI using the Shell function:

    from citizenshell import Shell
    localshell = Shell()
    telnetshell = Shell("telnet://")
    secureshell = Shell("ssh://")
    adbshell = Shell("adb://myandroiddevice:5555")
    serialshell = Shell("serial://jogn:secretpassword@/dev/ttyUSB3?baudrate=115200")

    you can also mix and match betweens providing arguments in the URI or via kwargs:

    telnetshell = Shell("telnet://", password="secretpassword", port=1234)
    serialshell = Shell("serial://john:secretpassword@/dev/ttyUSB3", baudrate=115200)

Using a shell

Once you have shell, any shell, you can call it directly and get the standart output:

assert shell("echo Hello World") == "Hello World"

You can also iterate over the standard output:

result = [int(x) for x in shell("""
    for i in 1 2 3 4; do
        echo $i;
assert result == [1, 2, 3, 4]

You don’t have to wait for the command to finish to receive the output.

This loop

for line in shell("for i in 1 2 3 4; do echo -n 'It is '; date +%H:%M:%S; sleep 1; done", wait=False)
    print ">>>", line + "!"

would produce something like:

>>> It is 14:24:52!
>>> It is 14:24:53!
>>> It is 14:24:54!
>>> It is 14:24:55!

You can extract stdout, stderr and exit code seperately:

result = shell(">&2 echo error && echo output && exit 13")
assert result.stdout() == ["output"]
assert result.stderr() == ["error"]
assert result.exit_code() == 13

You can inject environment variable to the shell

assert shell("echo $VAR", VAR="bar") == "bar"

By default, shell inherits “$CWD” from the environment (aka $PWD).

Still, if ever a command needs to be run from a custom path, one way to achieve this is:

shell = LocalShell()

This works … but it is ugly! Two levels of abstraction are mixed.

This is better:

shell = LocalShell()
shell('first_command', cwd=first_custom_path)
shell('second_command', cwd=second_custom_path)

The shell can raise an exception if the exit code is non-zero:

assert shell("exit 13").exit_code() == 13 # will not raise any exception
    shell("exit 13", check_xc=True) # will raise an exception
    assert False, "will not be reached"
except ShellError as e:
    assert True, "will be reached"

The shell can also raise an exception if something is printed on the standard error:

shell("echo DANGER >&2").stderr() == ["DANGER"] # will not raise any exception
    shell("echo DANGER >&2", check_err=True) # will raise an exception
    assert False, "will not be reached"
except ShellError as e:
    assert True, "will be reached"

You can pull file from the remote host (for LocalShell it’s just doing a copy):

shell("echo -n test > remote_file.txt")
shell.pull("local_file.txt", "remote_file.txt")
assert open("local_file.txt", "r").read() == "test"

or push file to the remote host (again, for LocalShell it’s just doing a copy):

open("local_file.txt", "w").write("test")
shell.push("local_file.txt", "remote_file.txt")
assert str(shell("cat remote_file.txt")) == "test"

Project details

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
citizenshell-2.2.0-py2-none-any.whl (15.1 kB) Copy SHA256 hash SHA256 Wheel py2 Jun 10, 2018
citizenshell-2.2.0.tar.gz (16.2 kB) Copy SHA256 hash SHA256 Source None Jun 10, 2018

Supported by

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