sshreader 6.2.0__tar.gz → 7.0.0__tar.gz

sshreader-7.0.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.1
+Name: sshreader
+Version: 7.0.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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: homepage, https://sshreader.readthedocs.io/
+Project-URL: repository, https://github.com/isaiah1112/sshreader
+Requires-Python: <4.0,>=3.11
+Requires-Dist: click>=8.4.2
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: paramiko>=5.0.0
+Requires-Dist: progressbar2>=4.5.0
+Requires-Dist: python-hostlist>=2.3.0
+Description-Content-Type: text/markdown
+
+![SSHreader 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)
+
+# SSHreader
+
+SSHreader is a Python library for running commands on multiple servers in parallel. It wraps [Paramiko](https://www.paramiko.org/) and provides both a direct SSH client and a job-based interface for parallel SSH and local shell work. It also includes `pydsh`, a command-line tool for running commands across host lists.
+
+SSHreader supports Python 3.11 and later.
+
+## Installation
+
+Install the latest release from PyPI:
+
+```bash
+python -m pip install sshreader
+```
+
+## Quick start
+
+Use `SSH` to run commands in a single SSH session. SSHreader can use an SSH key, an SSH agent, or a password:
+
+```python
+from sshreader import SSH
+
+with SSH("myhost.example.com", username="jdoe", keyfile="~/.ssh/id_ed25519") as ssh:
+    result = ssh.ssh_command("uname -a")
+    print(result.stdout)
+    print(result.return_code)
+```
+
+Use `ServerJob` and `sshread` to run jobs on multiple hosts. A job can contain multiple commands, which run sequentially on that host:
+
+```python
+from sshreader import ServerJob, sshread
+
+hosts = ["server1.example.com", "server2.example.com"]
+jobs = [
+    ServerJob(host, ["hostname", "uptime"], username="jdoe", keyfile="~/.ssh/id_ed25519")
+    for host in hosts
+]
+
+finished_jobs = sshread(jobs, tcount=0)
+for job in finished_jobs:
+    print(job.name, job.status)
+    for result in job.results:
+        print(result.cmd, result.stdout, result.stderr, result.return_code)
+```
+
+`tcount=0` selects a thread count based on the available CPUs and number of jobs. Use `pcount=0` to enable multiprocessing; you can also combine process and thread workers. When using multiprocessing, put the call to `sshread` inside the standard `if __name__ == "__main__":` guard.
+
+Each command result has `cmd`, `stdout`, `stderr`, and `return_code` fields. A `ServerJob` stores its command results in `results` and the sum of their return codes in `status`.
+
+## Other features
+
+- Run one or more commands over a reusable SSH connection with `SSH.ssh_command`.
+- Transfer files over SFTP with `SSH.sftp_put` and `SSH.sftp_get`.
+- Run local commands with `shell_command` (shell-free by default; use `shell=True` only when needed) or create local `ServerJob` instances with `run_local=True`.
+- Use `Hook` objects to run functions before or after a job, including hooks that use its established SSH connection.
+- Discover the current username, SSH keys, and agent keys with `envvars()`.
+- Configure connection and command timeouts, SSH ports, output handling, and worker counts.
+
+See the [documentation](https://sshreader.readthedocs.io/) for detailed API guides and examples.
+
+## `pydsh`
+
+Installing SSHreader also installs the `pydsh` command. It accepts [hostlist expressions](https://pypi.org/project/python-hostlist/) and runs a command across the expanded hosts:
+
+```bash
+pydsh -w 'web[01-10].example.com' 'uname -r'
+```
+
+By default, `pydsh` uses the current username and available SSH keys or agent, prompting for a password when needed. You can specify credentials and group or coalesce output:
+
+```bash
+pydsh -u jdoe -k ~/.ssh/id_ed25519 -D -w 'web[01-10].example.com' 'uname -r'
+```
+
+Use `pydsh --help` to see all options. With `-F`, the command argument is treated as a script file; the script must start with a shebang (`#!`), and `--confirm` skips the execution confirmation prompt.
+
+## Development
+
+To set up a local development environment and run the tests:
+
+```bash
+uv sync --group test
+uv run --group test pytest
+```
+
+Run lint and type checks with:
+
+```bash
+uv run --group test ruff check sshreader tests
+uv run --group test ty check sshreader
+```
+
+## Contributing
+
+Bug reports, feature requests, and code contributions are welcome. Please [open an issue](https://github.com/isaiah1112/sshreader/issues) with a minimal example and relevant traceback when reporting a problem. Contributions can be submitted as pull requests to the [GitHub repository](https://github.com/isaiah1112/sshreader).
+
+## License
+
+SSHreader is released under the [GNU Lesser General Public License v3.0 or later](https://www.gnu.org/licenses/lgpl-3.0.html). See [LICENSE](./LICENSE) and [LICENSE.lesser](./LICENSE.lesser) for the license texts.

sshreader-7.0.0/README.md

@@ -0,0 +1,103 @@
+![SSHreader 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)
+
+# SSHreader
+
+SSHreader is a Python library for running commands on multiple servers in parallel. It wraps [Paramiko](https://www.paramiko.org/) and provides both a direct SSH client and a job-based interface for parallel SSH and local shell work. It also includes `pydsh`, a command-line tool for running commands across host lists.
+
+SSHreader supports Python 3.11 and later.
+
+## Installation
+
+Install the latest release from PyPI:
+
+```bash
+python -m pip install sshreader
+```
+
+## Quick start
+
+Use `SSH` to run commands in a single SSH session. SSHreader can use an SSH key, an SSH agent, or a password:
+
+```python
+from sshreader import SSH
+
+with SSH("myhost.example.com", username="jdoe", keyfile="~/.ssh/id_ed25519") as ssh:
+    result = ssh.ssh_command("uname -a")
+    print(result.stdout)
+    print(result.return_code)
+```
+
+Use `ServerJob` and `sshread` to run jobs on multiple hosts. A job can contain multiple commands, which run sequentially on that host:
+
+```python
+from sshreader import ServerJob, sshread
+
+hosts = ["server1.example.com", "server2.example.com"]
+jobs = [
+    ServerJob(host, ["hostname", "uptime"], username="jdoe", keyfile="~/.ssh/id_ed25519")
+    for host in hosts
+]
+
+finished_jobs = sshread(jobs, tcount=0)
+for job in finished_jobs:
+    print(job.name, job.status)
+    for result in job.results:
+        print(result.cmd, result.stdout, result.stderr, result.return_code)
+```
+
+`tcount=0` selects a thread count based on the available CPUs and number of jobs. Use `pcount=0` to enable multiprocessing; you can also combine process and thread workers. When using multiprocessing, put the call to `sshread` inside the standard `if __name__ == "__main__":` guard.
+
+Each command result has `cmd`, `stdout`, `stderr`, and `return_code` fields. A `ServerJob` stores its command results in `results` and the sum of their return codes in `status`.
+
+## Other features
+
+- Run one or more commands over a reusable SSH connection with `SSH.ssh_command`.
+- Transfer files over SFTP with `SSH.sftp_put` and `SSH.sftp_get`.
+- Run local commands with `shell_command` (shell-free by default; use `shell=True` only when needed) or create local `ServerJob` instances with `run_local=True`.
+- Use `Hook` objects to run functions before or after a job, including hooks that use its established SSH connection.
+- Discover the current username, SSH keys, and agent keys with `envvars()`.
+- Configure connection and command timeouts, SSH ports, output handling, and worker counts.
+
+See the [documentation](https://sshreader.readthedocs.io/) for detailed API guides and examples.
+
+## `pydsh`
+
+Installing SSHreader also installs the `pydsh` command. It accepts [hostlist expressions](https://pypi.org/project/python-hostlist/) and runs a command across the expanded hosts:
+
+```bash
+pydsh -w 'web[01-10].example.com' 'uname -r'
+```
+
+By default, `pydsh` uses the current username and available SSH keys or agent, prompting for a password when needed. You can specify credentials and group or coalesce output:
+
+```bash
+pydsh -u jdoe -k ~/.ssh/id_ed25519 -D -w 'web[01-10].example.com' 'uname -r'
+```
+
+Use `pydsh --help` to see all options. With `-F`, the command argument is treated as a script file; the script must start with a shebang (`#!`), and `--confirm` skips the execution confirmation prompt.
+
+## Development
+
+To set up a local development environment and run the tests:
+
+```bash
+uv sync --group test
+uv run --group test pytest
+```
+
+Run lint and type checks with:
+
+```bash
+uv run --group test ruff check sshreader tests
+uv run --group test ty check sshreader
+```
+
+## Contributing
+
+Bug reports, feature requests, and code contributions are welcome. Please [open an issue](https://github.com/isaiah1112/sshreader/issues) with a minimal example and relevant traceback when reporting a problem. Contributions can be submitted as pull requests to the [GitHub repository](https://github.com/isaiah1112/sshreader).
+
+## License
+
+SSHreader is released under the [GNU Lesser General Public License v3.0 or later](https://www.gnu.org/licenses/lgpl-3.0.html). See [LICENSE](./LICENSE) and [LICENSE.lesser](./LICENSE.lesser) for the license texts.

{sshreader-6.2.0 → sshreader-7.0.0}/pyproject.toml

@@ -2,16 +2,16 @@
 authors = [
     { name = "Jesse Almanrode", email = "jesse@almanrode.com" },
 ]
-requires-python = "<4.0,>3.9"
+requires-python = ">=3.11,<4.0"
 dependencies = [
-    "click<9,>=8",
-    "colorama<1.0,>=0.4",
-    "paramiko<4,>=3",
-    "progressbar2<5,>=4",
-    "python-hostlist<2,>=1",
+    "click>=8.4.2",
+    "colorama>=0.4.6",
+    "paramiko>=5.0.0",
+    "progressbar2>=4.5.0",
+    "python-hostlist>=2.3.0",
 ]
 name = "sshreader"
-version = "6.2.0"
+version = "7.0.0"
 description = "Multi-threading/processing wrapper for Paramiko"
 readme = "README.md"
 classifiers = [
@@ -20,11 +20,11 @@ classifiers = [
     "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",
+    "Programming Language :: Python :: 3.15",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
@@ -33,8 +33,8 @@ classifiers = [
 text = "LGPL-3.0-or-later"
 
 [project.urls]
-homepage = "http://sshreader.readthedocs.io/"
-repository = "https://bitbucket.org/isaiah1112/sshreader/"
+homepage = "https://sshreader.readthedocs.io/"
+repository = "https://github.com/isaiah1112/sshreader"
 
 [project.scripts]
 pydsh = "sshreader.scripts.pydsh:cli"
@@ -44,6 +44,9 @@ includes = [
     "sshreader",
     "sshreader/scripts",
 ]
+excludes = [
+    "**/.DS_Store",
+]
 
 [tool.ruff.lint]
 select = [
@@ -74,9 +77,11 @@ build-backend = "pdm.backend"
 
 [dependency-groups]
 test = [
-    "coverage<8,>=7",
-    "discover<1.0,>=0.4",
-    "ruff<1.0.0,>=0.9.9",
+    "coverage>=7.15.2",
+    "discover>=0.4.0",
+    "pytest>=9.1.1",
+    "ruff>=0.15.22",
+    "ty>=0.0.60",
 ]
 docs = [
     "sphinx<8,>=7",

{sshreader-6.2.0 → sshreader-7.0.0}/sshreader/__init__.py

@@ -1,6 +1,6 @@
 """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

{sshreader-6.2.0 → sshreader-7.0.0}/sshreader/customtypes.py

@@ -1,6 +1,6 @@
 """ 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
@@ -14,23 +14,23 @@
 #
 #     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
+from typing import NamedTuple
 
 
 class Command(NamedTuple):
     cmd: str
-    stdout: Optional[Union[str, bytes]]
-    stderr: Optional[Union[str, bytes]]
+    stdout: str | bytes | None
+    stderr: str | bytes | None
     return_code: int
 
 
 class EnvVars(NamedTuple):
-    username: Optional[str]
-    agent_keys: Optional[list]
-    dsa_key: Optional[str]
-    ecdsa_key: Optional[str]
-    rsa_key: Optional[str]
+    username: str | None
+    agent_keys: list[object] | None
+    dsa_key: str | None
+    ecdsa_key: str | None
+    rsa_key: str | None
 
 
-Timeout = Union[int, float]
+Timeout = int | float
 TimeoutTuple = tuple[Timeout, Timeout]

{sshreader-6.2.0 → sshreader-7.0.0}/sshreader/scripts/__init__.py

@@ -1,6 +1,6 @@
 """ 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