citizenshell 1.1.3

LocalShell

you can use the built-in sh command for simple commands:

from citizenshell import sh

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

you can instanciate a LocalShell for more complex cases:

from citizenshell import LocalShell

shell = LocalShell(GREET="Hello")
assert shell("echo $GREET $WHO", WHO="Citizen") == "Hello Citizen"

you can also iterate over stdout:

from citizenshell import LocalShell

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

or you can extract stdout, stderr and exit code seperately:

from citizenshell import LocalShell

shell = LocalShell()
result = shell(">&2 echo error && echo output && exit 13")
assert result.out == ["output"]
assert result.err == ["error"]
assert result.xc == 13

TelnetShell

you can instanciate the TelnetShell for shell over telnet:

from citizenshell import TelnetShell

shell = TelnetShell(hostname="acme.org", username="john", password="secretpassword")
assert shell("echo Hello World") == "Hello World"

you can then do eveything you can do with a LocalShell.

SecureShell

you can instanciate the SecureShell for shell over SSH:

from citizenshell import SecureShell

shell = SecureShell(hostname="acme.org", username="john", password="secretpassword")
assert shell("echo Hello World") == "Hello World"

you can then do eveything you can do with a LocalShell. Beware that some SSH servers refuse to set environment variable (see documentation of AcceptEnv of sshd_config and documentation of update_environment of paramiko’s ``Channel` class <http://docs.paramiko.org/en/2.4/api/channel.html>`__) and that will fail silently.

AdbShell

you can instanciate the AdbShell for shell over ADB:

from citizenshell import AdbShell

shell = AdbShell(hostname="acme.org", username="john", password="secretpassword")
assert shell("echo Hello World") == "Hello World"

you can then do eveything you can do with a LocalShell.

SerialShell

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", password="secretpassword", baudrate=115200, parity=PARITY_NONE, bytesize=EIGHTBITS)
assert shell("echo Hello World") == "Hello World"

you can then do eveything you can do with a LocalShell.

Shell

you can also obtain shell objects by URI using the Shell function:

from citizenshell import Shell

localshell = Shell()
telnetshell = Shell("telnet://john:secretpassword@acme.org:1234")
secureshell = Shell("ssh://john:secretpassword@acme.org:1234")
adbshell = Shell("adb://myandroiddevice:5555")
serialshell = Shell("serial://jogn:secretpassword@/dev/ttyUSB3?baudrate=115200")

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

from citizenshell import Shell

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

you can then use the shell objects as you would any other.