Skip to content

Commit 4866cee

Browse files
committed
Updated documentation some more
1 parent d22eadb commit 4866cee

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ parallel-ssh
33

44
Small wrapper library over paramiko that allows for parallel execution of SSH commands on remote hosts and executing simple single host commands over SSH.
55

6-
parallel-ssh uses asychronous network requests, there is *no* multi-threading or multi-processing used. This is a *requirement* for commands on many (hundreds) of hosts which would grind a system to a halt simply by having so many processes/threads all wanting to execute if done with multi-threading/processing.
6+
parallel-ssh uses asychronous network requests - there is *no* multi-threading or multi-processing used.
7+
8+
This is a *requirement* for commands on many (hundreds/thousands/hundreds of thousands) of hosts which would grind a system to a halt simply by having so many processes/threads all wanting to execute if done with multi-threading/processing.
79

810
.. image:: https://api.travis-ci.org/pkittenis/parallel-ssh.png?branch=master
911
:target: https://travis-ci.org/pkittenis/parallel-ssh

pssh.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
#!/usr/bin/env python
22

3-
"""Module containing wrapper classes over paramiko.SSHClient
4-
See SSHClient and ParallelSSHClient
3+
"""Small wrapper library over paramiko that allows for parallel execution of SSH commands on remote hosts and executing simple single host commands over SSH.
4+
5+
parallel-ssh uses asychronous network requests - there is *no* multi-threading or multi-processing used.
6+
7+
This is a *requirement* for commands on many (hundreds/thousands/hundreds of thousands) of hosts which would grind a system to a halt simply by having so many processes/threads all wanting to execute if done with multi-threading/processing.
8+
9+
See :mod:`pssh.SSHClient` and :mod:`pssh.ParallelSSHClient` for class documentation.
510
611
Copyright (C) 2014 Panos Kittenis
712

0 commit comments

Comments
 (0)