https://github.com/xavierhardy/harbinger

Abstract transport to connect to remote servers with performance in mind
https://github.com/xavierhardy/harbinger

libssh2 network paramiko performance shell ssh ssh-client transport

Last synced: 10 days ago
JSON representation

Abstract transport to connect to remote servers with performance in mind

• Host: GitHub
• URL: https://github.com/xavierhardy/harbinger
• Owner: xavierhardy
• License: apache-2.0
• Created: 2018-07-24T20:03:41.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-12-19T20:53:45.000Z (about 2 years ago)
• Last Synced: 2024-03-20T00:10:30.817Z (almost 2 years ago)
• Topics: libssh2, network, paramiko, performance, shell, ssh, ssh-client, transport
• Language: Python
• Size: 106 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Harbinger

=========

Abstract transport to connect to remote servers with performance in mind

.. image:: docs/source/images/logo_256.png

Installation

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

.. code:: sh

   sudo apt-get install make

   python setup.py install

Examples

--------

Install the dependencies.

.. code:: sh

   pip install .[ssh2,paramiko]

Run one of the examples in the ``examples`` folder.

.. code:: sh

   env PYTHONPATH=$PYTHONPATH:$(pwd) examples/telnet_ls_shell.py

.. code::

   Configuring Telnet connection

   Hostname: localhost

   Port: 23

   Username: user

   Password:

   Creating Telnet connection object

   Connecting

   Sending 'ls'

   Receiving output

   bin   dev  home  lib64  mnt  proc  run   srv  tmp  var

   boot  etc  lib   media  opt  root  sbin  sys  usr

   Disconnecting

   Done

Tests

-----

Install tests requirements.

.. code:: sh

   sudo apt-get install make

   pip install -r requirements/dev.txt

Run Nose and Flake 8.

.. code:: sh

   nosetests

   flake8 *.py harbinger docs

If you are running Python 3.6+, install and execute Black.

.. code:: sh

   pip install black

.. code:: sh

   black --exclude harbinger/execeptions.py --diff --check -l 79 *.py harbinger docs

Documentation

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

The documentation is available on ReadTheDocs: https://harbinger.readthedocs.io/en/latest/

Building the documentation

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

Install Sphinx requirements.

.. code:: sh

   sudo apt-get install make

   pip install sphinx

Run Sphinx.

.. code:: sh

   make -C docs html

The resulting HTML pages are available in `docs/build/html`.