Multi-threading/processing wrapper for Paramiko
Project description
sshreader
Overview
SSHreader is a Python Module for multiprocessing/threading ssh connections in order to make ssh operations across multiple servers parallel. It utilizes the Paramiko module for its ssh client.
In order to maintain the widest range of compatibility, SSHreader is currently tested using the following versions of Python:
- Python3.7
- Python3.8
- Python3.9
- Python3.10
- Python3.11
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:
pip install sshreader
This will ensure that all the requirements are met.
Development Installation
If you are wanting to work on development of SSHreader perform the following:
make install
To ensure all development requirements are met. This will allow you to build the Sphinx Documentation for SSHreader or run the unit/integration tests!
Documentation
The documentation for SSHreader can be found here
Building Docs
If you have installed the requirements for SSHreader you can build its Sphinx Documentation simply by:
make docs
Then simply open docs/build/html/index.html
in your browser.
Contributing
Comments and enhancements are very welcome.
Report any issues or feature requests on the BitBucket bug tracker. 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 and submit pull requests to the develop branch.
Extras
Included with sshreader is a binary called pydsh (generally installed in /usr/local/bin/). This works very similar to pdsh 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 to get its list of hosts to process.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sshreader-5.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1cb8e57b49b945a8b9c2fe874876d205fa4531de3b01818ed003e0619a4dd02 |
|
MD5 | a48e29fef65c302f94e4c659fba599be |
|
BLAKE2b-256 | e7b21d0c05e3c7d33d1052bcdb05eca8adcf3c3f0a9f6b04511b49ebc2aea431 |