In order to maintain the widest range of compatibility, sshreader is currently tested using the following versions of
The most straightforward way to get the sshreader module working for you is:
pip install sshreader
python setup.py install
This will ensure that all the requirements are met.
If you are wanting to work on development of sshreader perform the following:
pip install -U -r requirements.txt
To ensure all development requirements are met. This will allow you to build the Sphinx Documentation for sshreader!
The documentation for sshreader can be found at http://sshreader.readthedocs.io/
If you have installed the requirements for sshreader you can build its Sphinx Documentation simply by:
Then simply open docs/build/html/index.html in your browser.
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
Code contributions are encouraged: please feel free to fork the
project and submit pull requests to the develop branch.
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