https://github.com/ansible/pylibssh

Python bindings specific to Ansible use case for libssh https://www.libssh.org/
https://github.com/ansible/pylibssh

Last synced: about 1 month ago
JSON representation

Python bindings specific to Ansible use case for libssh https://www.libssh.org/

• Host: GitHub
• URL: https://github.com/ansible/pylibssh
• Owner: ansible
• License: lgpl-2.1
• Created: 2020-01-13T15:09:41.000Z (over 5 years ago)
• Default Branch: devel
• Last Pushed: 2025-05-08T01:51:50.000Z (about 2 months ago)
• Last Synced: 2025-05-08T02:36:48.110Z (about 2 months ago)
• Language: Cython
• Homepage: https://ansible-pylibssh.rtfd.io
• Size: 83.1 MB
• Stars: 68
• Watchers: 38
• Forks: 33
• Open Issues: 38
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: .github/CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE.rst
  • Code of conduct: .github/CODE_OF_CONDUCT.rst
  • Security: .github/SECURITY.rst
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/pypi/v/ansible-pylibssh.svg?logo=Python&logoColor=white

   :target: https://pypi.org/project/ansible-pylibssh

.. image:: https://img.shields.io/badge/license-LGPL+-blue.svg?maxAge=3600

   :target: https://pypi.org/project/ansible-pylibssh

.. image:: https://img.shields.io/pypi/pyversions/ansible-pylibssh.svg?logo=Python&logoColor=white

   :target: https://pypi.org/project/ansible-pylibssh

.. image:: https://github.com/ansible/pylibssh/actions/workflows/ci-cd.yml/badge.svg?event=push

   :alt: 🧪 CI/CD @ devel

   :target: https://github.com/ansible/pylibssh/actions/workflows/ci-cd.yml

.. image:: https://img.shields.io/codecov/c/gh/ansible/pylibssh/devel?logo=codecov&logoColor=white

   :target: https://codecov.io/gh/ansible/pylibssh

   :alt: devel branch coverage via Codecov

.. image:: https://img.shields.io/badge/style-wemake-000000.svg

   :target: https://github.com/wemake-services/wemake-python-styleguide

.. image:: https://img.shields.io/badge/Code%20of%20Conduct-Ansible-silver.svg

   :target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html

   :alt: Ansible Code of Conduct

.. DO-NOT-REMOVE-docs-badges-END

pylibssh: Python bindings to client functionality of libssh specific to Ansible use case

========================================================================================

.. DO-NOT-REMOVE-docs-intro-START

Nightlies @ Dumb PyPI @ GitHub Pages

------------------------------------

.. DO-NOT-REMOVE-nightlies-START

We publish nightlies on tags and pushes to devel.

They are hosted on a GitHub Pages based index generated

by `dumb-pypi `_.

The web view is @ https://ansible.github.io/pylibssh/.

.. code-block:: shell-session

    $ pip install \

        --extra-index-url=https://ansible.github.io/pylibssh/simple/ \

        --pre \

        ansible-pylibssh

.. DO-NOT-REMOVE-nightlies-END

Requirements

------------

You need Python 3.9+

pylibssh requires libssh to be installed in particular:

- libssh version 0.9.0 and later.

  To install libssh refer to its `Downloads page

  `__.

Building the module

-------------------

In the local env, assumes there's a libssh shared library

on the system, build toolchain is present and env vars

are set properly:

.. code-block:: shell-session

    $ git clone https://github.com/ansible/pylibssh.git

    $ cd pylibssh

    $ pip install tox

    $ tox -e build-dists

``manylinux``-compatible wheels:

.. code-block:: shell-session

    $ git clone https://github.com/ansible/pylibssh.git

    $ cd pylibssh

    $ pip install tox

    $ tox -e build-dists-manylinux1-x86_64  # with Docker

    # or with Podman

    $ DOCKER_EXECUTABLE=podman tox -e build-dists-manylinux1-x86_64

    # to enable shell script debug mode use

    $ tox -e build-dists-manylinux1-x86_64 -- -e DEBUG=1

Communication

-------------

Join the Ansible forum:

* `Get Help `_: get help or help others. Please add the appropriate tags if you start new discussions, for example the ``pylibssh`` tag.

* `Posts tagged with 'pylibssh' `_: subscribe to participate in project-related conversations.

* `News & Announcements `_: track project-wide announcements including social events and the `Bullhorn newsletter `_.

* `Social Spaces `_: gather and interact with fellow enthusiasts.

For more information about getting in touch with us, see the `Ansible communication guide `_.

License

-------

This library is distributed under the terms of LGPL 2 or higher,

see file ``LICENSE.rst`` in this repository.