# ssh-python

**Repository Path**: mirrors_ParallelSSH/ssh-python

## Basic Information

- **Project Name**: ssh-python
- **Description**: Python bindings for libssh C library.
- **Primary Language**: Unknown
- **License**: LGPL-2.1
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

ssh-python
============

Bindings for libssh_ C library.

.. image:: https://img.shields.io/badge/License-LGPL%20v2-blue.svg
   :target: https://pypi.python.org/pypi/ssh-python
   :alt: License
.. image:: https://img.shields.io/pypi/v/ssh-python.svg
   :target: https://pypi.python.org/pypi/ssh-python
   :alt: Latest Version
.. image:: https://circleci.com/gh/ParallelSSH/ssh-python/tree/master.svg?style=shield
   :target: https://circleci.com/gh/ParallelSSH/ssh-python/tree/master
.. image:: https://img.shields.io/pypi/wheel/ssh-python.svg
   :target: https://pypi.python.org/pypi/ssh-python
.. image:: https://img.shields.io/pypi/pyversions/ssh-python.svg
   :target: https://pypi.python.org/pypi/ssh-python
.. image:: https://ci.appveyor.com/api/projects/status/2t4bmmtjvfy5s1in/branch/master?svg=true
   :target: https://ci.appveyor.com/project/pkittenis/ssh-python
.. image:: https://readthedocs.org/projects/ssh-python/badge/?version=latest
   :target: http://ssh-python.readthedocs.org/en/latest/
   :alt: Latest documentation


Installation
_____________

Binary wheels are provided for Linux (manylinux 2014, x86_64 and aarch64), OSX (12, 13 and 14 for brew Python), and Windows 64-bit (Python 3.8+).

Wheels have *no dependencies*.

For building from source, see `documentation <https://ssh-python.readthedocs.io/en/latest/installation.html#building-from-source>`_.


.. code-block:: shell

   pip install ssh-python

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

.. code-block:: shell

   pip install -U pip
   pip install ssh-python


Quick Start
_____________

See `command execution script <https://github.com/ParallelSSH/ssh-python/blob/master/examples/exec.py>`_ for complete example.

Features
_________

The library provides Python bindings to the ``libssh`` C library.

* 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 bindings
* 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


.. _libssh: https://www.libssh.org