ssh2-python
============
Super fast SSH2 protocol library. ``ssh2-python`` provides Python bindings for `libssh2`_.
.. image:: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg
:target: https://pypi.python.org/pypi/ssh2-python
:alt: License
.. image:: https://img.shields.io/pypi/v/ssh2-python.svg
:target: https://pypi.python.org/pypi/ssh2-python
:alt: Latest Version
.. image:: https://circleci.com/gh/ParallelSSH/ssh2-python/tree/master.svg?style=svg
:target: https://circleci.com/gh/ParallelSSH/ssh2-python
.. image:: https://ci.appveyor.com/api/projects/status/github/parallelssh/ssh2-python?svg=true&branch=master
:target: https://ci.appveyor.com/project/pkittenis/ssh2-python
.. image:: https://img.shields.io/pypi/wheel/ssh2-python.svg
:target: https://pypi.python.org/pypi/ssh2-python
.. image:: https://img.shields.io/pypi/pyversions/ssh2-python.svg
:target: https://pypi.python.org/pypi/ssh2-python
.. image:: https://readthedocs.org/projects/ssh2-python/badge/?version=latest
:target: http://ssh2-python.readthedocs.org/en/latest/
:alt: Latest documentation
Installation
______________
Binary wheel packages are provided for Linux, OSX and Windows, all Python versions. Wheel packages have **no dependencies**.
``pip`` may need to be updated to be able to install binary wheel packages - ``pip install -U pip``.
.. code-block:: shell
pip install ssh2-python
For from source installation instructions, including building against system provided libssh2, `see documentation <https://ssh2-python.readthedocs.io/en/latest/installation.html#installation-from-source>`_.
Who Should Use This
___________________
Most developers will want to use the `high level clients <https://parallel-ssh.readthedocs.io/en/latest/quickstart.html#single-host-client>`_
in `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_
based on this library.
This library provides bindings to the low-level libssh2 C-API. It is *not* high level, nor easy to use. A *lot* of code
would need to be written to use this library that is already provided by `parallel-ssh`.
Use `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_ unless *really* sure using a C-API is what is wanted.
API Feature Set
________________
At this time all of the `libssh2`_ API has been implemented up to the libssh2 version in the repository. Please report any missing implementation.
Complete example scripts for various operations can be found in the `examples directory`_.
In addition, as ``ssh2-python`` is a thin wrapper of ``libssh2`` with Python semantics, `its code examples <https://libssh2.org/examples/>`_ can be ported straight over to Python with only minimal changes.
Examples
_____________
See `examples directory <https://github.com/ParallelSSH/ssh2-python/tree/master/examples>`_ for complete examples.
Again, most developers will want to use `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_ rather than this
library directly.
Comparison with other Python SSH libraries
-------------------------------------------
Performance of above example, compared with Paramiko.
.. code-block:: shell
time python examples/example_echo.py
time python examples/paramiko_comparison.py
:Output:
``ssh2-python``::
real 0m0.141s
user 0m0.037s
sys 0m0.008s
``paramiko``::
real 0m0.592s
user 0m0.351s
sys 0m0.021s
.. _libssh2: https://www.libssh2.org
.. _Cython: https://www.cython.org
.. _`examples directory`: https://github.com/ParallelSSH/ssh2-python/tree/master/examples
.. _`mail group`: https://groups.google.com/forum/#!forum/ssh2-python
Raw data
{
"_id": null,
"home_page": "https://github.com/ParallelSSH/ssh2-python",
"name": "ssh2-python",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Panos Kittenis",
"author_email": "22e889d8@opayq.com",
"download_url": null,
"platform": "any",
"description": "ssh2-python\n============\n\nSuper fast SSH2 protocol library. ``ssh2-python`` provides Python bindings for `libssh2`_.\n\n.. image:: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg\n :target: https://pypi.python.org/pypi/ssh2-python\n :alt: License\n.. image:: https://img.shields.io/pypi/v/ssh2-python.svg\n :target: https://pypi.python.org/pypi/ssh2-python\n :alt: Latest Version\n.. image:: https://circleci.com/gh/ParallelSSH/ssh2-python/tree/master.svg?style=svg\n :target: https://circleci.com/gh/ParallelSSH/ssh2-python\n.. image:: https://ci.appveyor.com/api/projects/status/github/parallelssh/ssh2-python?svg=true&branch=master\n :target: https://ci.appveyor.com/project/pkittenis/ssh2-python\n.. image:: https://img.shields.io/pypi/wheel/ssh2-python.svg\n :target: https://pypi.python.org/pypi/ssh2-python\n.. image:: https://img.shields.io/pypi/pyversions/ssh2-python.svg\n :target: https://pypi.python.org/pypi/ssh2-python\n.. image:: https://readthedocs.org/projects/ssh2-python/badge/?version=latest\n :target: http://ssh2-python.readthedocs.org/en/latest/\n :alt: Latest documentation\n\n\nInstallation\n______________\n\nBinary wheel packages are provided for Linux, OSX and Windows, all Python versions. Wheel packages have **no dependencies**.\n\n``pip`` may need to be updated to be able to install binary wheel packages - ``pip install -U pip``.\n\n.. code-block:: shell\n\n pip install ssh2-python\n\nFor from source installation instructions, including building against system provided libssh2, `see documentation <https://ssh2-python.readthedocs.io/en/latest/installation.html#installation-from-source>`_.\n\nWho Should Use This\n___________________\n\nMost developers will want to use the `high level clients <https://parallel-ssh.readthedocs.io/en/latest/quickstart.html#single-host-client>`_\nin `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_\nbased on this library.\n\nThis library provides bindings to the low-level libssh2 C-API. It is *not* high level, nor easy to use. A *lot* of code\nwould need to be written to use this library that is already provided by `parallel-ssh`.\n\nUse `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_ unless *really* sure using a C-API is what is wanted.\n\nAPI Feature Set\n________________\n\nAt this time all of the `libssh2`_ API has been implemented up to the libssh2 version in the repository. Please report any missing implementation.\n\nComplete example scripts for various operations can be found in the `examples directory`_.\n\nIn addition, as ``ssh2-python`` is a thin wrapper of ``libssh2`` with Python semantics, `its code examples <https://libssh2.org/examples/>`_ can be ported straight over to Python with only minimal changes.\n\nExamples\n_____________\n\nSee `examples directory <https://github.com/ParallelSSH/ssh2-python/tree/master/examples>`_ for complete examples.\n\nAgain, most developers will want to use `parallel-ssh <https://github.com/ParallelSSH/parallel-ssh>`_ rather than this\nlibrary directly.\n\nComparison with other Python SSH libraries\n-------------------------------------------\n\nPerformance of above example, compared with Paramiko.\n\n.. code-block:: shell\n\n time python examples/example_echo.py\n time python examples/paramiko_comparison.py\n\n:Output:\n\n ``ssh2-python``::\n\n real\t0m0.141s\n user\t0m0.037s\n sys\t0m0.008s\n\n ``paramiko``::\n\n real\t0m0.592s\n user\t0m0.351s\n sys\t0m0.021s\n\n\n.. _libssh2: https://www.libssh2.org\n.. _Cython: https://www.cython.org\n.. _`examples directory`: https://github.com/ParallelSSH/ssh2-python/tree/master/examples\n.. _`mail group`: https://groups.google.com/forum/#!forum/ssh2-python\n",
"bugtrack_url": null,
"license": "LGPLv2",
"summary": "Bindings for libssh2 C library",
"version": "1.1.2.post1",
"project_urls": {
"Homepage": "https://github.com/ParallelSSH/ssh2-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9256b3b9473020f99f3df0e5e0e92cef8abef08a273493eea44b9d771099d246",
"md5": "a7e7370b883e5fdbeef8dbc934fe5215",
"sha256": "b1012086f8f48a215f9d646799da352431ec5ac246f284d1c00d30a45ebcdf7b"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "a7e7370b883e5fdbeef8dbc934fe5215",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 4222731,
"upload_time": "2025-01-23T03:13:06",
"upload_time_iso_8601": "2025-01-23T03:13:06.700065Z",
"url": "https://files.pythonhosted.org/packages/92/56/b3b9473020f99f3df0e5e0e92cef8abef08a273493eea44b9d771099d246/ssh2_python-1.1.2.post1-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c4f0fa5de562be7130375c445561074aed6f5b214c6c45ef7f1f61a13625c2cf",
"md5": "c0c44f7ce157cbf04a6f7c6c57230aac",
"sha256": "52efc9a017016d35a3bb3c45ef292bfcf2e4c7f73866fc3b39be7e41ac14d440"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp311-cp311-macosx_12_0_arm64.whl",
"has_sig": false,
"md5_digest": "c0c44f7ce157cbf04a6f7c6c57230aac",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 1844981,
"upload_time": "2025-01-23T03:09:35",
"upload_time_iso_8601": "2025-01-23T03:09:35.180830Z",
"url": "https://files.pythonhosted.org/packages/c4/f0/fa5de562be7130375c445561074aed6f5b214c6c45ef7f1f61a13625c2cf/ssh2_python-1.1.2.post1-cp311-cp311-macosx_12_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9bfdeb973a72c5c3664f0d47f83de96746e10e03fc10b9df05510d8c19d63f5f",
"md5": "d47186ea03dbf30e2b08de1148d45599",
"sha256": "e388d573324254d73d410a44549cdbacb4b7fa970a421132f1d8e8ca01d42967"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp311-cp311-macosx_13_0_arm64.whl",
"has_sig": false,
"md5_digest": "d47186ea03dbf30e2b08de1148d45599",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 2326239,
"upload_time": "2025-01-23T03:07:36",
"upload_time_iso_8601": "2025-01-23T03:07:36.183674Z",
"url": "https://files.pythonhosted.org/packages/9b/fd/eb973a72c5c3664f0d47f83de96746e10e03fc10b9df05510d8c19d63f5f/ssh2_python-1.1.2.post1-cp311-cp311-macosx_13_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ce2ba8478bf90c35d86a85dd5e13e188cea2c81fddfbc3efb16a2fec37d6bee9",
"md5": "2657ee478a5fcf42dd9f28c812eec6a6",
"sha256": "9e4aaeab5ade22324522314c6992f1a07e1d30fb109c2d3eb4eac6a15df501f3"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "2657ee478a5fcf42dd9f28c812eec6a6",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 4223589,
"upload_time": "2025-01-23T03:13:08",
"upload_time_iso_8601": "2025-01-23T03:13:08.366681Z",
"url": "https://files.pythonhosted.org/packages/ce/2b/a8478bf90c35d86a85dd5e13e188cea2c81fddfbc3efb16a2fec37d6bee9/ssh2_python-1.1.2.post1-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e1591daac3eda23220ee323364bcf93dd8972a74870597d45b6fced78c1e66e",
"md5": "54965c85c72b11139dcb6cb291232048",
"sha256": "3892d56a340df0dbc4f57d2debb7e17a5b93b171af27b2b71d4b3351304863ff"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp312-cp312-macosx_14_0_arm64.whl",
"has_sig": false,
"md5_digest": "54965c85c72b11139dcb6cb291232048",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 3049981,
"upload_time": "2025-01-23T03:11:56",
"upload_time_iso_8601": "2025-01-23T03:11:56.087215Z",
"url": "https://files.pythonhosted.org/packages/3e/15/91daac3eda23220ee323364bcf93dd8972a74870597d45b6fced78c1e66e/ssh2_python-1.1.2.post1-cp312-cp312-macosx_14_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2033cd685009f12243d76fe4a5249a17f5a3229989d3163c44a344007e1e36b3",
"md5": "7d1367c863a03e05bb701ad9e91fbb41",
"sha256": "84694163693310aac0482ab131d1743b5459dfe0de26201dc20e2e6e31168bc0"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "7d1367c863a03e05bb701ad9e91fbb41",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 4221651,
"upload_time": "2025-01-23T03:13:10",
"upload_time_iso_8601": "2025-01-23T03:13:10.665545Z",
"url": "https://files.pythonhosted.org/packages/20/33/cd685009f12243d76fe4a5249a17f5a3229989d3163c44a344007e1e36b3/ssh2_python-1.1.2.post1-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8d3b12db397a7935d743b4b4c51ab7be9bc5289c3466e2eba6acd5f5bc00afa6",
"md5": "0f93358839da842af97fc276345dc758",
"sha256": "431a549ee28a5cefd6facd1eec7a47e1125fb34b05628b2092eeb7799755e470"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp313-cp313-win_amd64.whl",
"has_sig": false,
"md5_digest": "0f93358839da842af97fc276345dc758",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": null,
"size": 4210838,
"upload_time": "2025-01-23T03:13:12",
"upload_time_iso_8601": "2025-01-23T03:13:12.869428Z",
"url": "https://files.pythonhosted.org/packages/8d/3b/12db397a7935d743b4b4c51ab7be9bc5289c3466e2eba6acd5f5bc00afa6/ssh2_python-1.1.2.post1-cp313-cp313-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "39a250961f28b04402a6470553ce817291b0e82644238eeaae298dab1bcabdfd",
"md5": "31f71b53a01a79f7d314bdb0ec4dd322",
"sha256": "800e32cdaefb6fdab90549d1943483937c633b3f052c0101610d49dd9e472b04"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp37-cp37m-win_amd64.whl",
"has_sig": false,
"md5_digest": "31f71b53a01a79f7d314bdb0ec4dd322",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": null,
"size": 4236995,
"upload_time": "2025-01-23T03:13:14",
"upload_time_iso_8601": "2025-01-23T03:13:14.390691Z",
"url": "https://files.pythonhosted.org/packages/39/a2/50961f28b04402a6470553ce817291b0e82644238eeaae298dab1bcabdfd/ssh2_python-1.1.2.post1-cp37-cp37m-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3bf5522ba794eb5ea6884c692d2e1e810988eb7e3a805f31443bfc6cad63dad1",
"md5": "f36cf354f7155d14967b93e651994450",
"sha256": "22e94797c140f4c8f6cba79503847dbce987a20ea2202a61c078ba60b1af9abc"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "f36cf354f7155d14967b93e651994450",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 4235987,
"upload_time": "2025-01-23T03:13:16",
"upload_time_iso_8601": "2025-01-23T03:13:16.990825Z",
"url": "https://files.pythonhosted.org/packages/3b/f5/522ba794eb5ea6884c692d2e1e810988eb7e3a805f31443bfc6cad63dad1/ssh2_python-1.1.2.post1-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "da2a297e7fceda5a2355c6c69c4cc74c84166e530a6c1efb9cd36d0b6331136d",
"md5": "a8ed326c4491ae2fa92cdd73d7fc5eab",
"sha256": "6b4b8c5ca99da0c033301056fb76c21a1fc91b4a1eca6c8155c8299f7cb59d22"
},
"downloads": -1,
"filename": "ssh2_python-1.1.2.post1-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "a8ed326c4491ae2fa92cdd73d7fc5eab",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 4231732,
"upload_time": "2025-01-23T03:13:19",
"upload_time_iso_8601": "2025-01-23T03:13:19.065012Z",
"url": "https://files.pythonhosted.org/packages/da/2a/297e7fceda5a2355c6c69c4cc74c84166e530a6c1efb9cd36d0b6331136d/ssh2_python-1.1.2.post1-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 03:13:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ParallelSSH",
"github_project": "ssh2-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"circle": true,
"lcname": "ssh2-python"
}
JSON
