Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.96 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.96 KB

RedSSH

PyPI License: GPL v2

Test Status Documentation Status Coverage Status

Connect to SSH servers in python easily and with C speed! Interacting with SSH shouldn't be hard, slow or limited to certain SSH severs. Based on ssh2-python (which provides libssh2 bindings for python) and made into an easy to use SSH library with the focus being ease of use and speed. SSH should be as easy as a pre-wrapped TLS TCP socket, it should work well, be fast in execution and be simple to interact with.

Installing

RedSSH can be installed via pip with pip install redssh or the latest commit, which may not be the most stable, from git with pip install git://[email protected]/Red_M/redssh.git

Documentation

99% of questions around how to do something should be answered in the documentation. If something is not there please raise an issue so it can be added to the documentation. Now with autodocs!

Why not use [other software]?

I've found other automation libraries or solutions lacking, such as:

  • Compatibility with remote servers (odd servers causes the library to be unable to connect).
  • Feature set is limited (eg, no tunneling).
  • Focuses on only connecting to Linux servers.
  • Requires an agent to be installed, a state file to be present or a master "server".
  • Poor performance.

TO DO

  • More error based unit tests
  • More examples
  • Host based authentication
  • X11 forwarding