Refactoring - moved clients to pssh.clients. Added paramiko and import deprecation warnings. Updated readme, docs for new modules.

Author: Pan

README.rst

@@ -77,18 +77,18 @@ The new client is based on ``libssh2`` via the ``ssh2-python`` extension library
 
 See `this post <https://parallel-ssh.org/post/parallel-ssh-libssh2>`_ for a performance comparison of the available clients.
 
-To make use of this new client, ``ParallelSSHClient`` can be imported from ``pssh.pssh2_client`` instead. Their respective APIs are almost identical.
+To make use of this new client, ``ParallelSSHClient`` can be imported from ``pssh.clients.native`` instead. Their respective APIs are almost identical.
 
-The new client will become the default and will replace the current ``pssh.pssh_client`` in a new major version of the library - ``2.0.0`` - once remaining features have been implemented.
+The new client will become the default and will replace the current ``pssh.pssh_client`` in a new major version of the library - ``2.0.0``.
 
-The current default client will remain available as an option under a new name.
+The paramiko based client will remain available under ``pssh.clients.miko``.
 
 For example:
 
 .. code-block:: python
 
   from pprint import pprint
-  from pssh.pssh2_client import ParallelSSHClient
+  from pssh.clients.native import ParallelSSHClient
 
   hosts = ['myhost1', 'myhost2']
   client = ParallelSSHClient(hosts)
@@ -187,7 +187,7 @@ To copy a local file to remote hosts in parallel:
 
 .. code-block:: python
 
-  from pssh.pssh_client import ParallelSSHClient
+  from pssh.clients import ParallelSSHClient
   from pssh.utils import enable_logger, logger
   from gevent import joinall
 

doc/advanced.rst

@@ -27,7 +27,7 @@ A private key can also be provided programmatically.
 .. code-block:: python
 
   from pssh.utils import load_private_key
-  from pssh import ParallelSSHClient
+  from pssh.pssh_client import ParallelSSHClient
 
   client = ParallelSSHClient(hosts, pkey=load_private_key('my_key'))
 
@@ -60,13 +60,15 @@ Use of an available SSH agent can also be disabled.
 Programmatic SSH Agent
 -----------------------
 
+*Paramiko client only*.
+
 It is also possible to programmatically provide an SSH agent for the client to use, instead of a system provided one. This is useful in cases where hosts need different private keys and a system SSH agent is not available.
 
 .. code-block:: python
    
    from pssh.agent import SSHAgent
    from pssh.utils import load_private_key
-   from pssh import ParallelSSHClient
+   from pssh.clients.miko import ParallelSSHClient
 
    agent = SSHAgent()
    agent.add_key(load_private_key('my_private_key_filename'))
@@ -94,11 +96,11 @@ The new client is based on ``libssh2`` via the ``ssh2-python`` extension library
 
 See `this post <https://parallel-ssh.org/post/parallel-ssh-libssh2>`_ for a performance comparison of the available clients.
 
-To make use of this new client, ``ParallelSSHClient`` can be imported from ``pssh.pssh2_client`` instead. Their respective APIs are almost identical. 
+To make use of this new client, ``ParallelSSHClient`` can be imported from ``pssh.clients.native`` instead. Their respective APIs are almost identical. 
 
 .. code-block:: python
 
-  from pssh.pssh2_client import ParallelSSHClient
+  from pssh.clients.native import ParallelSSHClient
 
   hosts = ['my_host', 'my_other_host']
   client = ParallelSSHClient(hosts)
@@ -316,7 +318,7 @@ Run with sudo
    output = client.run_command(<..>, sudo=True)
    client.join(output)
 
-While not best practice and password-less `sudo` is best configured for a limited set of commands, a sudo password may be provided via the stdin channel:
+While not best practice and password-less ``sudo`` is best configured for a limited set of commands, a sudo password may be provided via the stdin channel:
 
 .. code-block:: python
 
@@ -350,8 +352,6 @@ Contents of ``stdout`` will be `UTF-16` encoded.
 Disabling use of pseudo terminal emulation
 --------------------------------------------
 
-By default, ``parallel-ssh`` uses the user's configured shell to run commands with. As a shell is used by default, a pseudo terminal (`PTY`) is also requested by default.
-
 For cases where use of a `PTY` is not wanted, such as having separate stdout and stderr outputs, the remote command is a daemon that needs to fork and detach itself or when use of a shell is explicitly disabled, use of PTY can also be disabled.
 
 The following example prints to stderr with PTY disabled.
@@ -374,7 +374,7 @@ The following example prints to stderr with PTY disabled.
 Combined stdout/stderr
 -----------------------
 
-With a PTY, stdout and stderr output is combined.
+With a PTY on the paramiko client, stdout and stderr output is combined.
 
 The same example as above with a PTY:
 
@@ -470,14 +470,14 @@ If wanting to copy a file from a single remote host and retain the original file
 
 .. code-block:: python
 
-   from pssh.ssh_client import SSHClient
+   from pssh.pssh_client import SSHClient
 
    client = SSHClient('localhost')
    client.copy_remote_file('remote_filename', 'local_filename')
 
 .. seealso::
 
-   :py:func:`SSHClient.copy_remote_file <pssh.ssh_client.SSHClient.copy_remote_file>`  API documentation and exceptions raised.
+   :py:func:`SSHClient.copy_remote_file <pssh.clients.native.SSHClient.copy_remote_file>`  API documentation and exceptions raised.
 
 
 Hosts filtering and overriding

doc/quickstart.rst

@@ -12,9 +12,9 @@ First, make sure that ``parallel-ssh`` is `installed <installation.html>`_.
 
    If you are seeing messages like ``This operation would block forever``, this is the cause.
 
-   Monkey patching is only done for the clients under ``pssh.pssh_client`` and ``pssh.ssh_client`` for parallel and single host clients respectively.
+   Monkey patching is only done for the clients under ``pssh.clients.miko``.
 
-   New native library based clients under ``pssh.pssh2_client`` and ``pssh.ssh2_client`` **do not perform monkey patching** and are an option if monkey patching is not suitable. These clients will become the default in a future major release - ``2.0.0``.
+   New native library based clients under ``pssh.clients.native`` **do not perform monkey patching** and are an option if monkey patching is not suitable. These clients will become the default, replacing the current ``pssh.pssh_client``, in a future major release - ``2.0.0``.
 
 Run a command on hosts in parallel
 ------------------------------------
@@ -138,19 +138,19 @@ For the native client (``pssh.pssh2_client``), only private key filepath is need
 
  .. code-block:: python
 
-   from pssh.pssh2_client import ParallelSSHClient
+   from pssh.clients.native import ParallelSSHClient
 
    client = ParallelSSHClient(hosts, pkey='my_pkey')
 
 Paramiko Client
 __________________
 
-For the paramiko based client, the helper function :py:func:`load_private_key <pssh.utils.load_private_key>` is provided to easily load all possible key types. It takes either a file path or a file-like object.
+For the paramiko based client only, the helper function :py:func:`load_private_key <pssh.utils.load_private_key>` is provided to easily load all possible key types. It takes either a file path or a file-like object.
 
  :File path:
    .. code-block:: python
 
-      from pssh.pssh_client import ParallelSSHClient
+      from pssh.clients.miko import ParallelSSHClient
       from pssh.utils import load_private_key
       
       pkey = load_private_key('my_pkey.pem')

pssh/clients/__init__.py

@@ -0,0 +1,4 @@
+# flake8: noqa: F401
+
+from .native.parallel import ParallelSSHClient
+from .native.single import SSHClient

pssh/base_pssh.py renamed to pssh/clients/base_pssh.py

@@ -24,9 +24,9 @@
 import gevent.pool
 from gevent.hub import Hub
 
-from .exceptions import HostArgumentException
-from .constants import DEFAULT_RETRIES, RETRY_DELAY
-from .output import HostOutput
+from ..exceptions import HostArgumentException
+from ..constants import DEFAULT_RETRIES, RETRY_DELAY
+from ..output import HostOutput
 
 
 Hub.NOT_ERROR = (Exception,)

pssh/clients/miko/__init__.py

@@ -0,0 +1,4 @@
+# flake8: noqa: F401
+
+from .parallel import ParallelSSHClient
+from .single import SSHClient, logger