qaviton-ssh

qaviton ssh


License
Apache-2.0
Install
pip install qaviton-ssh==2019.10.18.22.29.29.465016

Documentation

Qaviton SSH

logo
version license open issues downloads code size

making ssh super easy

Installation

pip install --upgrade qaviton_ssh

Requirements

  • Python 3.6+

Features

  • simple ssh send-recieve api ✓
  • async requests ✗ (coming soon)
  • multi-session workflow ✗ (coming soon)

Usage

creating an ssh client

from qaviton_ssh import SSH
# hostname is a reachable address for the machine
# username is the allowed user to have ssh access
# private_key is the file path or string of the private key
client = SSH(hostname='x.x.x.x', username='username', private_key='pkey.pem')

response = client.send('echo "hello world"')
print(response.data, response.error)  # server will respond with b'hello world', b''

create a python script on the server

cd = 'cd myproject'
file = 'script.py'
response = client.send_many([cd, f'touch {file}', f'echo "print(\"script success\")" > {file}'])
assert not response.error

execute the script

response = client.send_many([cd, f'python {file}'])
assert not response.error
print(response.data)  # server will respond with b'script success'