libssh C library bindings for Python.


Keywords
cython, extension, library, libssh, python, python-library, ssh, ssh-client, ssh2
License
LGPL-2.1
Install
pip install ssh-python==1.0.0

Documentation

ssh-python

Bindings for libssh C library.

License Latest Version https://circleci.com/gh/ParallelSSH/ssh-python/tree/master.svg?style=shield https://ci.appveyor.com/api/projects/status/2t4bmmtjvfy5s1in/branch/master?svg=true Latest documentation

Installation

Binary wheels are provided for Linux (manylinux 2010), OSX (10.14 and 10.15 for brew Python), and Windows 64-bit (Python 3.6/3.7/3.8).

Wheels have no dependencies.

For building from source, see documentation.

pip install ssh-python

Pip may need to be updated to be able to install binary wheels.

pip install -U pip
pip install ssh-python

Quick Start

See command execution script for complete example.

Features

The library uses Cython based native code extensions as wrappers to libssh.

  • Thread safe - GIL released as much as possible
    • libssh threading limitations apply - anything not supported in C is not supported in Python
  • Very low overhead thin wrapper
  • Object oriented
    • Memory freed automatically and safely as objects are garbage collected by Python
  • Uses Python semantics where applicable
    • channel/file handle context manager support
    • channel/file handle iterator support
  • Raises low level C errors as Python exceptions