Parallel-ssh

++++++

Changes
--------

* Added `ssh-python` (`libssh <https://libssh.org>`_) based native client with `run_command` implementation.
* ``ParallelSSHClient.join`` with timeout no longer consumes output by default to allow reading of output after timeout.

Fixes
------

* ``ParallelSSHClient.join`` with timeout would raise ``Timeout`` before value given when client was busy with other commands.

.. note::

``ssh-python`` client at `pssh.clients.ssh.ParallelSSHClient` is available for testing. Please report any issues.

To use:

.. code-block:: python

from pssh.clients.ssh import ParallelSSHClient

This release adds (yet another) client, this one based on `ssh-python <https://github.com/ParallelSSH/ssh-python>`_ (`libssh <https://libssh.org>`_). Key features of this client are more supported authentication methods compared to `ssh2-python`.

Future releases will also enable certificate authentication for the ssh-python client.

Please migrate to one of the two native clients if have not already as paramiko is very quickly accumulating yet more bugs and the `2.0.0` release which removes it is imminent.

Users that require paramiko for any reason can pin their parallel-ssh versions to `parallel-ssh<2.0.0`.

++++++

Fixes
------

* `ParallelSSHClient` going out of scope would cause new client sessions to fail if `client.join` was not called prior - 200

++++++

Changes
-------

* Moved polling to gevent.select.poll to increase performance and better handle high number of sockets - 189
* ``HostOutput.exit_code`` is now a dynamic property returning either ``None`` when exit code not ready or the exit code as reported by channel. ``ParallelSSHClient.get_exit_codes`` is now a no-op and scheduled to be removed.
* Native client exit codes are now more explicit and return ``None`` if no exit code is ready. Would previously return ``0`` by default.


Packaging
---------

* Removed OSX Python 3.6 and 3.7 wheels. OSX wheels for brew python, currently 3.8, on OSX 10.14 and 10.15 are provided.

Fixes
------

* Native client would fail on opening sockets with large file descriptor values - 189

+++++++

Changes
--------

* Added ``return_list`` optional argument to ``run_command`` to return list of ``HostOutput`` objects as output rather than dictionary - defaults to ``False``. List output will become default starting from ``2.0.0``.
* Updated native clients for new version of ``ssh2-python``.
* Manylinux 2010 wheels.


Fixes
------

* Sockets would not be closed on client going out of scope - 175
* Calling ``join()`` would reset encoding set on ``run_command`` - 159

++++++

Fixes
-----

* Native client SCP and SFTP uploads would not handle partial writes from waiting on socket correctly.
* Native client ``copy_file`` SFTP upload would get stuck repeating same writes until killed when copying multi-MB files from Windows clients - 148
* Native client ``scp_send`` would not correctly preserve file mask of local file on the remote.
* Native client tunnel, used for proxy implementation, would not handle partial writes from waiting on socket correctly.

++++++

Changes
--------

* Removed libssh2 native library dependency in favour of bundled ``ssh2-python`` libssh2 library.
* Changed native client forward agent default behaviour to off due to incompatibility with certain SSH server implementations.
* Added keep-alive functionality to native client - defaults to ``60`` seconds. ``ParallelSSHClient(<..>, keepalive_seconds=<interval>)`` to configure interval. Set to ``0`` to disable.
* Added ``~/.ssh/id_ecdsa`` default identity location to native client.