sshreader 6.1.0__tar.gz → 6.3.0__tar.gz

sshreader-6.3.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: sshreader
+Version: 6.3.0
+Summary: Multi-threading/processing wrapper for Paramiko
+Author-Email: Jesse Almanrode <jesse@almanrode.com>
+License: LGPL-3.0-or-later
+Classifier: Programming Language :: Python
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: homepage, http://sshreader.readthedocs.io/
+Project-URL: repository, https://bitbucket.org/isaiah1112/sshreader/
+Requires-Python: <4.0,>3.9
+Requires-Dist: click<9,>=8
+Requires-Dist: colorama<1.0,>=0.4
+Requires-Dist: paramiko<4,>=3
+Requires-Dist: progressbar2<5,>=4
+Requires-Dist: python-hostlist<2,>=1
+Description-Content-Type: text/markdown
+
+![logo](./logo.png)
+
+[![Python Tests](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml)
+
+A Python Module for multiprocessing/threading ssh connections in order to make ssh operations
+across multiple servers parallel.  It utilizes the [Paramiko](http://www.paramiko.org/) module 
+for its ssh client.
+
+In order to maintain the widest range of compatibility, [SSHreader][] is currently tested 
+using [all supported versions of Python!](https://devguide.python.org/versions/)
+
+## License
+
+[SSHreader][] is released under [GNU Lesser General Public License v3.0][],
+see the file LICENSE and LICENSE.lesser for the license text.
+
+## Installation
+
+The most straightforward way to get the [SSHreader][] module working for you is:
+
+```commandline
+pip install sshreader
+```
+or, if you'd like to use a local install from the repo:
+```commandline
+make install
+```
+
+This ensures that all the requirements are met.
+
+## Documentation
+
+The documentation for [SSHreader][] can be found at [ReadTheDocs.](https://sshreader.readthedocs.io)
+
+## Contributing
+
+Comments and enhancements are very welcome.
+
+Report any issues or feature requests on the [GitHub Issue Tracker](https://github.com/isaiah1112/sshreader/issues). 
+Please include a minimal not-working example which reproduces the bug and, if appropriate, the
+traceback information.  Please do not request features already being worked
+towards.
+
+Code contributions are encouraged: please feel free to [fork the project](https://github.com/isaiah1112/sshreader) 
+and submit pull requests to the develop branch.
+
+## Extras
+
+Included with sshreader is a script called `pydsh`.  This works very similar to [pdsh](https://computing.llnl.gov/linux/pdsh.html) 
+but uses sshreader at its core to perform ssh commands in parallel and return the results.  
+The output of `pydsh` can also be piped through the `dshbak` tool that comes with pdsh.
+
+Pydsh uses [hostlist expressions](https://www.nsc.liu.se/~kent/python-hostlist/) to get its list of hosts
+to process.
+
+
+[GNU Lesser General Public License v3.0]: http://choosealicense.com/licenses/lgpl-3.0/ "LGPL v3"
+
+[sshreader]: https://github.com/isaiah1112/sshreader "SSHreader Package"

sshreader-6.3.0/README.md

@@ -0,0 +1,59 @@
+![logo](./logo.png)
+
+[![Python Tests](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/isaiah1112/sshreader/actions/workflows/lint_and_test.yml)
+
+A Python Module for multiprocessing/threading ssh connections in order to make ssh operations
+across multiple servers parallel.  It utilizes the [Paramiko](http://www.paramiko.org/) module 
+for its ssh client.
+
+In order to maintain the widest range of compatibility, [SSHreader][] is currently tested 
+using [all supported versions of Python!](https://devguide.python.org/versions/)
+
+## License
+
+[SSHreader][] is released under [GNU Lesser General Public License v3.0][],
+see the file LICENSE and LICENSE.lesser for the license text.
+
+## Installation
+
+The most straightforward way to get the [SSHreader][] module working for you is:
+
+```commandline
+pip install sshreader
+```
+or, if you'd like to use a local install from the repo:
+```commandline
+make install
+```
+
+This ensures that all the requirements are met.
+
+## Documentation
+
+The documentation for [SSHreader][] can be found at [ReadTheDocs.](https://sshreader.readthedocs.io)
+
+## Contributing
+
+Comments and enhancements are very welcome.
+
+Report any issues or feature requests on the [GitHub Issue Tracker](https://github.com/isaiah1112/sshreader/issues). 
+Please include a minimal not-working example which reproduces the bug and, if appropriate, the
+traceback information.  Please do not request features already being worked
+towards.
+
+Code contributions are encouraged: please feel free to [fork the project](https://github.com/isaiah1112/sshreader) 
+and submit pull requests to the develop branch.
+
+## Extras
+
+Included with sshreader is a script called `pydsh`.  This works very similar to [pdsh](https://computing.llnl.gov/linux/pdsh.html) 
+but uses sshreader at its core to perform ssh commands in parallel and return the results.  
+The output of `pydsh` can also be piped through the `dshbak` tool that comes with pdsh.
+
+Pydsh uses [hostlist expressions](https://www.nsc.liu.se/~kent/python-hostlist/) to get its list of hosts
+to process.
+
+
+[GNU Lesser General Public License v3.0]: http://choosealicense.com/licenses/lgpl-3.0/ "LGPL v3"
+
+[sshreader]: https://github.com/isaiah1112/sshreader "SSHreader Package"

sshreader-6.3.0/pyproject.toml

@@ -0,0 +1,86 @@
+[project]
+authors = [
+    { name = "Jesse Almanrode", email = "jesse@almanrode.com" },
+]
+requires-python = "<4.0,>3.9"
+dependencies = [
+    "click<9,>=8",
+    "colorama<1.0,>=0.4",
+    "paramiko<4,>=3",
+    "progressbar2<5,>=4",
+    "python-hostlist<2,>=1",
+]
+name = "sshreader"
+version = "6.3.0"
+description = "Multi-threading/processing wrapper for Paramiko"
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.license]
+text = "LGPL-3.0-or-later"
+
+[project.urls]
+homepage = "http://sshreader.readthedocs.io/"
+repository = "https://bitbucket.org/isaiah1112/sshreader/"
+
+[project.scripts]
+pydsh = "sshreader.scripts.pydsh:cli"
+
+[tool.pdm.build]
+includes = [
+    "sshreader",
+    "sshreader/scripts",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "B",
+    "UP",
+    "B",
+    "SIM",
+    "I",
+]
+ignore = [
+    "E501",
+    "F401",
+]
+
+[[tool.uv.index]]
+name = "test-pypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[dependency-groups]
+test = [
+    "coverage<8,>=7",
+    "discover<1.0,>=0.4",
+    "pytest>=8.4.2",
+    "ruff<1.0.0,>=0.9.9",
+    "ty>=0.0.5",
+]
+docs = [
+    "sphinx<8,>=7",
+]

{sshreader-6.1.0 → sshreader-6.3.0}/sshreader/__init__.py

@@ -1,7 +1,6 @@
-# coding=utf-8
 """A Python Package for parallelizing ssh connections via threading and multiprocessing.
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -17,11 +16,12 @@
 #     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 # For backwards compatibility
-from .ssh import SSH, envvars
-from .customtypes import Command, EnvVars, Timeout, TimeoutTuple
-from .utils import ServerJob, Hook, sshread, echo, cpu_limit, shell_command
 import logging
 
+from .customtypes import Command, EnvVars, Timeout, TimeoutTuple
+from .ssh import SSH, envvars
+from .utils import Hook, ServerJob, cpu_limit, echo, shell_command, sshread
+
 __author__ = 'Jesse Almanrode (jesse@almanrode.com)'
 __all__ = ['ssh', 'customtypes', 'utils']
 

{sshreader-6.1.0 → sshreader-6.3.0}/sshreader/customtypes.py

@@ -1,7 +1,6 @@
-# coding=utf-8
 """ Typing module for sshreader
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -15,7 +14,7 @@
 #
 #     You should have received a copy of the GNU Lesser General Public License
 #     along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from typing import NamedTuple, Optional, Union, Tuple
+from typing import NamedTuple, Optional, Union
 
 
 class Command(NamedTuple):
@@ -34,4 +33,4 @@ class EnvVars(NamedTuple):
 
 
 Timeout = Union[int, float]
-TimeoutTuple = Tuple[Timeout, Timeout]
+TimeoutTuple = tuple[Timeout, Timeout]

{sshreader-6.1.0 → sshreader-6.3.0}/sshreader/scripts/__init__.py

@@ -1,7 +1,6 @@
-# coding=utf-8
 """ Scripts portion of sshreader package
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by

{sshreader-6.1.0 → sshreader-6.3.0}/sshreader/scripts/pydsh.py

@@ -1,7 +1,6 @@
-# coding=utf-8
 """ A Pythonic implementation of pdsh powered by sshreader
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -16,17 +15,20 @@
 #     You should have received a copy of the GNU Lesser General Public License
 #     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import logging
+import os
+import sys
 from collections import defaultdict
 from hashlib import md5
-from hostlist import expand_hostlist, collect_hostlist
+
 import click
-import logging
-import os
+from hostlist import collect_hostlist, expand_hostlist
+
 import sshreader
-import sys
+
 # GLOBALS
 __author__ = 'Jesse Almanrode'
-__version__ = '3.1.0'
+__version__ = '3.2.0'
 __examples__ = """\b
 Examples:
     pydsh -w host1,host2,host3 "uname -r"
@@ -63,10 +65,7 @@ def output(thisjob):
     :param thisjob: <ServerJob> object
     :return: None
     """
-    if thisjob.status == 255:
-        result = thisjob.results[0]
-    else:
-        result = thisjob.results[0].stdout
+    result = thisjob.results[0] if thisjob.status == 255 else thisjob.results[0].stdout
     if len(result) != 0:
         for line in result.split('\n'):
             sshreader.echo(str(thisjob.name) + ': ' + str(line))
@@ -103,13 +102,10 @@ def coalesce(jobresults):
     job_hashes = defaultdict(list)
     output_hashes = dict()
     for job in jobresults:
-        if job.status == 255:
-            result = job.results[0]
-        else:
-            result = job.results[0].stdout
+        result = job.results[0] if job.status == 255 else job.results[0].stdout
         md5sum = md5(result.encode()).hexdigest()
         job_hashes[md5sum].append(job.name)
-        if md5sum not in output_hashes.keys():
+        if md5sum not in output_hashes:
             output_hashes[md5sum] = result
 
     for md5sum, stdout in output_hashes.items():
@@ -130,7 +126,7 @@ def validate_hostlist(ctx, param, value):
     try:
         return expand_hostlist(value)
     except Exception:
-        raise click.BadOptionUsage(param, 'Invalid hostlist expression')
+        raise click.BadOptionUsage(param, 'Invalid hostlist expression') from None
 
 
 @click.command(epilog=__examples__)
@@ -166,10 +162,11 @@ def cli(**kwargs):
     if kwargs['file']:
         mkpath = click.Path(exists=True, dir_okay=False)
         script_path = mkpath(kwargs['cmd'])
-        script_name = os.path.split(script_path)[1]
+        # Ensure script_path is a str for os.path functions (type-checker safe)
+        script_name = os.path.basename(str(script_path))
         log.info('Creating copy_script prehook for: ' + script_name)
         prehook = sshreader.Hook(copy_script, args=[script_path], ssh_established=True)
-        with open(script_path) as s:
+        with open(str(script_path)) as s:
             script = s.readline()
         if script.startswith('#!') is False:
             raise click.UsageError('Script must start with #!')
@@ -200,7 +197,7 @@ def cli(**kwargs):
                 kwargs['keyfile'] = sshenv.dsa_key
                 log.info('Using DSA private key file')
         else:
-            if len(sshenv.agent_keys) == 0:
+            if sshenv.agent_keys is None or len(sshenv.agent_keys) == 0:
                 if not all((kwargs['username'], kwargs['password'])):
                     raise click.ClickException('Unable to find ssh key to use and password not supplied.')
             else:
@@ -218,7 +215,7 @@ def cli(**kwargs):
     # If you specify a password or prompt for one it overrides the ssh key
     if not kwargs['password']:
         if not kwargs['prompt']:
-            if not kwargs['keyfile'] and len(sshenv.agent_keys) == 0:
+            if not kwargs['keyfile'] and (sshenv.agent_keys is None or len(sshenv.agent_keys) == 0):
                 raise click.ClickException('Unable to find ssh key to use and password not supplied or prompt enabled.')
         else:
             log.info('Prompting for password and disabling discovered SSH keyfiles')
@@ -255,7 +252,7 @@ def cli(**kwargs):
             job.pre_hook = prehook
         jobs.append(job)
 
-    log.info('Sending %s ServerJobs to sshreader module' % (len(jobs),))
+    log.info(f'Sending {len(jobs)} ServerJobs to sshreader module')
     if kwargs['dshbak'] is False and kwargs['coalesce'] is False:
         if kwargs['redline']:
             sshreader.sshread(jobs, pcount=0, tcount=0, print_lock=True)

{sshreader-6.1.0 → sshreader-6.3.0}/sshreader/ssh.py

@@ -1,7 +1,6 @@
-# coding=utf-8
 """A wrapper for Paramiko that attempts to make ssh sessions easier to work with.
 """
-# Copyright (C) 2015-2025 Jesse Almanrode
+# Copyright (C) 2015-2026 Jesse Almanrode
 #
 #     This program is free software: you can redistribute it and/or modify
 #     it under the terms of the GNU Lesser General Public License as published by
@@ -17,12 +16,14 @@
 #     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 import logging
 import os
-import paramiko
 import socket
 from getpass import getuser
 from typing import Any, Optional
 
+import paramiko
+
 from .customtypes import Command, EnvVars, Timeout
+
 log = logging.getLogger('sshreader')
 
 
@@ -56,7 +57,7 @@ def envvars() -> EnvVars:
     return EnvVars(**env)
 
 
-class SSH(object):
+class SSH:
     """SSH Session class which can be used to send commands to a remote server.  It also supports basic SFTP commands
     and can be used to push/pull files from a remote system.
 
@@ -80,16 +81,14 @@ class SSH(object):
     """
     def __init__(self, fqdn: str, username: str, password: Optional[str] = None, keyfile: Optional[str] = None,
                  keypass: Optional[str] = None, port: int = 22, connect: bool = True, rsa_sha2: bool = True) -> None:
-        if not keyfile:
-            if len(paramiko.Agent().get_keys()) == 0:
-                if not all((username, password)):
-                    paramiko.SSHException('username and password or keyfile not provided')
+        if not keyfile and len(paramiko.Agent().get_keys()) == 0 and not all((username, password)):
+            paramiko.SSHException('username and password or keyfile not provided')
         self.host = fqdn
         self.username = username
         self.password = password
         if keyfile:
             if not isinstance(keyfile, str):
-                raise TypeError('expected %s for keyfile, got %s' % (str(str), str(type(keyfile))))
+                raise TypeError(f'expected {str(str)} for keyfile, got {str(type(keyfile))}')
             self.keyfile = os.path.abspath(os.path.expanduser(keyfile))
         else:
             self.keyfile = keyfile
@@ -122,7 +121,7 @@ class SSH(object):
         :return: Result of :meth:`paramiko.SFTPClient.put()`
         """
         if not self.__alive():
-            raise paramiko.SSHException("connection to %s not established" % (self.host,))
+            raise paramiko.SSHException(f"connection to {self.host} not established")
         sftp = paramiko.SFTPClient.from_transport(self._connection.get_transport())
         try:
             result = sftp.put(os.path.expanduser(srcfile), os.path.expanduser(dstfile))
@@ -140,7 +139,7 @@ class SSH(object):
         :return: None
         """
         if not self.__alive():
-            raise paramiko.SSHException("connection to %s not established" % (self.host,))
+            raise paramiko.SSHException(f"connection to {self.host} not established")
         sftp = paramiko.SFTPClient.from_transport(self._connection.get_transport())
         try:
             sftp.get(os.path.expanduser(srcfile), os.path.expanduser(dstfile))
@@ -164,7 +163,7 @@ class SSH(object):
         :raises: :class:`paramiko.SSHException`
         """
         if self.__alive() is False:
-            raise paramiko.SSHException("connection to %s not established" % (self.host, ))
+            raise paramiko.SSHException(f"connection to {self.host} not established")
         if combine:
             try:
                 stdin, stdout, stderr = self._connection.exec_command(command, timeout=timeout, get_pty=True)
@@ -174,7 +173,7 @@ class SSH(object):
                 else:
                     result = Command(cmd=command, stdout=stdout.read().strip(), stderr=None,
                                      return_code=stdout.channel.recv_exit_status())
-            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):
+            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):  # ty:ignore[possibly-missing-submodule]
                 result = Command(cmd=command, stdout='command timed out', stderr=None, return_code=124)
         else:
             try:
@@ -185,7 +184,7 @@ class SSH(object):
                 else:
                     result = Command(cmd=command, stdout=stdout.read().strip(), stderr=stderr.read().strip(),
                                      return_code=stdout.channel.recv_exit_status())
-            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):
+            except (paramiko.buffered_pipe.PipeTimeout, socket.timeout):  # ty:ignore[possibly-missing-submodule]
                 result = Command(cmd=command, stdout='', stderr='command timed out', return_code=124)
         return result
 
@@ -226,12 +225,10 @@ class SSH(object):
         :raises: :class:`paramiko.SSHException`
         """
         if self.__alive():
-            raise paramiko.SSHException("connection to %s already established" % (self.host, ))
-        paramiko.util.logging.getLogger().setLevel(logging.CRITICAL)  # Keeping paramiko from logging errors to stdout
-        if not self.keyfile:
-            if len(paramiko.Agent().get_keys()) == 0:
-                if not all((self.username, self.password)):
-                    paramiko.SSHException('username and password or keyfile not provided')
+            raise paramiko.SSHException(f"connection to {self.host} already established")
+        paramiko.util.logging.getLogger().setLevel(logging.CRITICAL)  # Keeping paramiko from logging errors to stdout  # ty:ignore[possibly-missing-submodule]
+        if not self.keyfile and len(paramiko.Agent().get_keys()) == 0 and not all((self.username, self.password)):
+            paramiko.SSHException('username and password or keyfile not provided')
         if self.keyfile:
             if self.rsa_sha2:
                 self._connection.connect(self.host, port=self.port, username=self.username, password=self.keypass,