Skip to content

Commit 259fc5d

Browse files
author
Dan
committed
Updated readme and requirements
1 parent 5cae198 commit 259fc5d

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,13 @@ Frequently asked questions
7575
Is Windows supported?
7676

7777
:A:
78-
Yes. Pip versions >= 8.0 are required for binary package installation of `gevent`, a dependency of `ParallelSSH`. Though `ParallelSSH` is pure python code and will run on any platform that has a working Python interpreter, its `gevent` dependency contains native code which either needs a binary package to be provided for the platform or to be built from source. Binary packages for `gevent` are provided for OSX, Linux and Windows platforms as of this time of writing.
78+
The library installs and works on Windows though not formally supported as unit tests are currently posix system only. Pip versions >= 8.0 are required for binary package installation of `gevent` on Windows, a dependency of `ParallelSSH`. Though `ParallelSSH` is pure python code and will run on any platform that has a working Python interpreter, its `gevent` dependency contains native code which either needs a binary package to be provided for the platform or to be built from source. Binary packages for `gevent` are provided for OSX, Linux and Windows platforms as of this time of writing.
7979

8080
:Q:
8181
Are SSH agents used?
8282

8383
:A:
84-
All available keys in a running SSH agent in addition to SSH keys in the user's home directory, `~/.ssh/id_dsa`, `~/.ssh/id_rsa` et al are automatically used by ParallelSSH.
84+
All available keys in a running SSH agent in addition to SSH keys in the user's home directory, `~/.ssh/id_dsa`, `~/.ssh/id_rsa` et al are automatically used by ParallelSSH. Use of SSH agent can be disabled by creating a client as `ParallelSSHClient(allow_agent=False)`. `See documentation <http://parallel-ssh.readthedocs.org/en/latest/>`_ for more information.
8585

8686
:Q:
8787
Can ParallelSSH forward my SSH agent?
@@ -93,7 +93,7 @@ Frequently asked questions
9393
Is tunneling/proxying supported?
9494

9595
:A:
96-
Yes, `ParallelSSH` natively supports tunelling through an intermediate SSH server. Connecting to a remote host is accomplished via an SSH tunnel using the SSH's protocol direct TCP tunneling feature, using local port forwarding. This is done natively in python and tunnel connections are asynchronous like all other connections in the ParallelSSH library. For example, client -> proxy SSH server -> remote SSH destination.
96+
Yes, `ParallelSSH` natively supports tunelling through an intermediate SSH server. Connecting to a remote host is accomplished via an SSH tunnel using the SSH's protocol direct TCP tunneling feature, using local port forwarding. This is done natively in python and tunnel connections are asynchronous like all other connections in the `ParallelSSH` library. For example, client -> proxy SSH server -> remote SSH destination.
9797

9898
Use the `proxy_host` and `proxy_port` parameters to configure your proxy.
9999

@@ -125,7 +125,8 @@ SFTP is supported (SCP version 2) natively, no `scp` command required.
125125

126126
For example to copy a local file to remote hosts in parallel
127127

128-
>>> from pssh import ParallelSSHClient
128+
>>> from pssh import ParallelSSHClient, utils
129+
>>> utils.enable_logger(utils.logger)
129130
>>> hosts = ['myhost1', 'myhost2']
130131
>>> client = ParallelSSHClient(hosts)
131132
>>> client.copy_file('../test', 'test_dir/test')

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
paramiko>=1.9,!=1.16.0
1+
paramiko>=1.12,!=1.16.0
22
gevent>=1.1rc3

0 commit comments

Comments
 (0)