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/jacobcallahan/ssh2-python",
"name": "ssh2-python312",
"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": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/jacobcallahan/ssh2-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da47234ce4fb24933e69811685add007c0a286355657a764e76d3338f0a9ddcb",
"md5": "9e2d37240157d19894563046cd3c0c37",
"sha256": "694487a93a551ff60a847c403fe126ccee8553b0f1d68c2e581cf47e16fdcb9d"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp310-cp310-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "9e2d37240157d19894563046cd3c0c37",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 2799624,
"upload_time": "2024-03-28T18:15:43",
"upload_time_iso_8601": "2024-03-28T18:15:43.599459Z",
"url": "https://files.pythonhosted.org/packages/da/47/234ce4fb24933e69811685add007c0a286355657a764e76d3338f0a9ddcb/ssh2_python312-0.1.1-cp310-cp310-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d90b17176914cdb6d78bf1187b9b748726d5030e46e896a2fdd4b7d3ad56c38e",
"md5": "9217bd37c4ab5aa44b31cefdf5d201c9",
"sha256": "ed5ae8920e4a529cf6f4883b7da4637a292128fb0b700e05b89d66796b4080d9"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "9217bd37c4ab5aa44b31cefdf5d201c9",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 3039853,
"upload_time": "2024-03-28T18:15:46",
"upload_time_iso_8601": "2024-03-28T18:15:46.898496Z",
"url": "https://files.pythonhosted.org/packages/d9/0b/17176914cdb6d78bf1187b9b748726d5030e46e896a2fdd4b7d3ad56c38e/ssh2_python312-0.1.1-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88987288ec464b02e89aa1cd209d258936aa8c36a7c1dcf9f607fbe1cb497dbd",
"md5": "5e22b23bff5399cadad6f25c6ac135de",
"sha256": "9fd7dfa133c862af74192c43576a4c145325282b3a919a671cf978a154cb305b"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl",
"has_sig": false,
"md5_digest": "5e22b23bff5399cadad6f25c6ac135de",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 4255372,
"upload_time": "2024-03-28T18:15:48",
"upload_time_iso_8601": "2024-03-28T18:15:48.548683Z",
"url": "https://files.pythonhosted.org/packages/88/98/7288ec464b02e89aa1cd209d258936aa8c36a7c1dcf9f607fbe1cb497dbd/ssh2_python312-0.1.1-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f96bc69071ffe91ca1b76a74cdb01ef846a0ba05353417aefed2b53dc201402",
"md5": "bcdbf81058e2e75ce0988134e1654cc7",
"sha256": "7a9c764c83db59a360c7427ac36088fc7222e61b340de208ed5a9a5f60133069"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "bcdbf81058e2e75ce0988134e1654cc7",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 4634751,
"upload_time": "2024-03-28T18:15:51",
"upload_time_iso_8601": "2024-03-28T18:15:51.076631Z",
"url": "https://files.pythonhosted.org/packages/8f/96/bc69071ffe91ca1b76a74cdb01ef846a0ba05353417aefed2b53dc201402/ssh2_python312-0.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b75e1fa193670ab544afca21f3d9ddd7c09d2f222d0f504208558e7a05c0368",
"md5": "4e3dc4c3f6cf651699126ce8b5a7e138",
"sha256": "122653d0bfe811fb45d6c13862db349032ec9b8c5d8d1944536affc53fe05e9a"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp311-cp311-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "4e3dc4c3f6cf651699126ce8b5a7e138",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 2802487,
"upload_time": "2024-03-28T18:15:52",
"upload_time_iso_8601": "2024-03-28T18:15:52.727239Z",
"url": "https://files.pythonhosted.org/packages/0b/75/e1fa193670ab544afca21f3d9ddd7c09d2f222d0f504208558e7a05c0368/ssh2_python312-0.1.1-cp311-cp311-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4dbc1fcc0825b8c724ebadfe7688472a55184293b2025b273127671232d4b3c",
"md5": "fed6f6259682af7134663f5a8d68ed77",
"sha256": "9e38f1a9475cb92a8742540148250d029d7e146a21db03750b5b8d2c1b141c6a"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "fed6f6259682af7134663f5a8d68ed77",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 3041703,
"upload_time": "2024-03-28T18:15:54",
"upload_time_iso_8601": "2024-03-28T18:15:54.339478Z",
"url": "https://files.pythonhosted.org/packages/e4/db/c1fcc0825b8c724ebadfe7688472a55184293b2025b273127671232d4b3c/ssh2_python312-0.1.1-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6156bfb0f83854cb074c6749c1769dd383f87a97d04fc6c024e09faa62203d57",
"md5": "d90a9acc274d289dc221e4e7f0316782",
"sha256": "efdc125b255cb39caa508ed8895964ee63c207e7871ccfa478384216d36f6288"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl",
"has_sig": false,
"md5_digest": "d90a9acc274d289dc221e4e7f0316782",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 4419372,
"upload_time": "2024-03-28T18:15:56",
"upload_time_iso_8601": "2024-03-28T18:15:56.915254Z",
"url": "https://files.pythonhosted.org/packages/61/56/bfb0f83854cb074c6749c1769dd383f87a97d04fc6c024e09faa62203d57/ssh2_python312-0.1.1-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66c0984c5cce3351e6166dc818e8f71da87f3aef4585323345454f09f72bd447",
"md5": "a6d02ee3590bfbcf5dcb03c278ef5e88",
"sha256": "15e61742937b299ac40ae567759d9916c05aaa4a2d43b6073abdc6254e87ffd3"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "a6d02ee3590bfbcf5dcb03c278ef5e88",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 4714305,
"upload_time": "2024-03-28T18:15:58",
"upload_time_iso_8601": "2024-03-28T18:15:58.542153Z",
"url": "https://files.pythonhosted.org/packages/66/c0/984c5cce3351e6166dc818e8f71da87f3aef4585323345454f09f72bd447/ssh2_python312-0.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0064dc37574e8cd076abb3e7a430ea24fac6e485928427f6e9edd70bb5971b2d",
"md5": "db5dfdbf355e4f7e21d0756a2bca1203",
"sha256": "3763989a0eeb1234399f13bffd527e1c85c4bc9a6931311d7ff61586f3027292"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp312-cp312-macosx_10_9_x86_64.whl",
"has_sig": false,
"md5_digest": "db5dfdbf355e4f7e21d0756a2bca1203",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 2798383,
"upload_time": "2024-03-28T18:16:02",
"upload_time_iso_8601": "2024-03-28T18:16:02.182809Z",
"url": "https://files.pythonhosted.org/packages/00/64/dc37574e8cd076abb3e7a430ea24fac6e485928427f6e9edd70bb5971b2d/ssh2_python312-0.1.1-cp312-cp312-macosx_10_9_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83aabd9f1e3901a53d3a83049506b0dfb306b186bb113d40783b0ff5c8644057",
"md5": "f8333f8fd3b521e3464dd008da7b6e37",
"sha256": "b2d4c3e9154f456f8befaf81b0e7647e06a5ee613ff6b227340cecb029c11c77"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp312-cp312-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "f8333f8fd3b521e3464dd008da7b6e37",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 3038384,
"upload_time": "2024-03-28T18:16:04",
"upload_time_iso_8601": "2024-03-28T18:16:04.691741Z",
"url": "https://files.pythonhosted.org/packages/83/aa/bd9f1e3901a53d3a83049506b0dfb306b186bb113d40783b0ff5c8644057/ssh2_python312-0.1.1-cp312-cp312-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8a87606ee85f56406f202e3981cc10305d3dc531c55d73d863a0f5ecda4c582",
"md5": "abbb52294041cc6af8732c8571e8ebc2",
"sha256": "721d7f7f452fa34296e3dea2484fe795fe4a06ac71b17325eed5148bf8594108"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl",
"has_sig": false,
"md5_digest": "abbb52294041cc6af8732c8571e8ebc2",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 4527322,
"upload_time": "2024-03-28T18:16:07",
"upload_time_iso_8601": "2024-03-28T18:16:07.143964Z",
"url": "https://files.pythonhosted.org/packages/b8/a8/7606ee85f56406f202e3981cc10305d3dc531c55d73d863a0f5ecda4c582/ssh2_python312-0.1.1-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46b3f59afc708467b044d471f43a639b5687a5fae44b1b5c36be0595ad7192e1",
"md5": "eab94b854e00b8eff4cb2f10c2322750",
"sha256": "e597616ee450e3ffbd357b2001cae459a45a8a9ae9b5282df7247ca710b57971"
},
"downloads": -1,
"filename": "ssh2_python312-0.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "eab94b854e00b8eff4cb2f10c2322750",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 4907762,
"upload_time": "2024-03-28T18:16:09",
"upload_time_iso_8601": "2024-03-28T18:16:09.933040Z",
"url": "https://files.pythonhosted.org/packages/46/b3/f59afc708467b044d471f43a639b5687a5fae44b1b5c36be0595ad7192e1/ssh2_python312-0.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 18:15:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jacobcallahan",
"github_project": "ssh2-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"circle": true,
"lcname": "ssh2-python312"
}
JSON
