Skip to content

Commit 7293474

Browse files
authored
Updated documentation, readme (#262)
* Updated documentation, readme
1 parent 8dfbb4e commit 7293474

File tree

3 files changed

+5
-11
lines changed

3 files changed

+5
-11
lines changed

README.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -278,14 +278,5 @@ Directory recursion is supported in both cases via the ``recurse`` parameter - d
278278
See `SFTP and SCP documentation <https://parallel-ssh.readthedocs.io/en/latest/advanced.html#sftp-scp>`_ for more examples.
279279

280280

281-
*****************
282-
Design And Goals
283-
*****************
284-
285-
``parallel-ssh``'s design goals and motivation are to provide a *library* for running *non-blocking* asynchronous SSH commands in parallel and on single hosts with little to no load induced on the system by doing so with the intended usage being completely programmatic and non-interactive.
286-
287-
To meet these goals, API driven solutions are preferred first and foremost. This frees up developers to drive the library via any method desired, be that environment variables, CI driven tasks, command line tools, existing OpenSSH or new configuration files, from within an application et al.
288-
289-
290281
.. image:: https://ga-beacon.appspot.com/UA-9132694-7/parallel-ssh/README.rst?pixel
291282
:target: https://github.com/igrigorik/ga-beacon

doc/advanced.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Proxy host can be configured in Per-Host Configuration:
181181
HostConfig(proxy_host='127.0.0.3'),
182182
HostConfig(proxy_host='127.0.0.4'),
183183
]
184-
clieent = ParallelSSHClient(hosts, host_config=host_config)
184+
client = ParallelSSHClient(hosts, host_config=host_config)
185185
output = client.run_command('echo me')
186186
187187
See :py:mod:`HostConfig <pssh.config.HostConfig>` for all possible configuration.
@@ -274,7 +274,8 @@ In some cases, such as when the remote command never terminates unless interrupt
274274
.. code-block:: python
275275
276276
output = client.run_command(
277-
'while true; do echo a line; sleep .1; done', use_pty=True, read_timeout=1)
277+
'while true; do echo a line; sleep .1; done',
278+
use_pty=True, read_timeout=1)
278279
279280
# Read as many lines of output as hosts have sent before the timeout
280281
stdout = []

doc/introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ Taking a cue from `PEP 20 <https://www.python.org/dev/peps/pep-0020/>`_, heavy e
1818
* Beautiful is better than ugly
1919

2020
Contributions are asked to keep these in mind.
21+
22+
In addition, a heavy emphasis is also given to test driven development. The library is continuously integration tested with a real SSH server (OpenSSH) and has very high code test coverage.

0 commit comments

Comments
 (0)