Skip to content

Commit 66c3f6a

Browse files
committed
Added license, updated docstring
1 parent a50c0b7 commit 66c3f6a

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

LICENSE.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Copyright (C) 2012 Panos Kittenis
2+
3+
This library is free software; you can redistribute it and/or
4+
modify it under the terms of the GNU Lesser General Public
5+
License as published by the Free Software Foundation; either
6+
version 2.1 of the License, or (at your option) any later version.
7+
8+
This library is distributed in the hope that it will be useful,
9+
but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11+
Lesser General Public License for more details.
12+
13+
You should have received a copy of the GNU Lesser General Public
14+
License along with this library; if not, write to the Free Software
15+
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

pssh.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ def __init__(self, host,
3939
"""Connect to host honoring any user set configuration in ~/.ssh/config or /etc/ssh/ssh_config
4040
:type: str
4141
:param host: Hostname to connect to
42+
:type str:
43+
:param user: (Optional) User to login as. Defaults to logged in user or user from ~/.ssh/config if set
4244
:throws: paramiko.AuthenticationException on authentication error
4345
:throws: ssh_client.UnknownHostException on DNS resolution error
4446
:throws: ssh_client.ConnectionErrorException on error connecting"""
@@ -102,8 +104,11 @@ def __init__(self, hosts, pool_size = 10,
102104
:param hosts: Hosts to connect to
103105
:type: int
104106
:param pool_size: Pool size - how many commands to run in parallel
107+
:type str:
108+
:param user: (Optional) User to login as. Defaults to logged in user or user from ~/.ssh/config if set
105109
:throws: paramiko.AuthenticationException on authentication error
106-
:throws: ssh_client.UnknownHostException on DNS resolution error"""
110+
:throws: ssh_client.UnknownHostException on DNS resolution error
111+
:throws: ssh_client.ConnectionErrorException on error connecting"""
107112
self.pool = gevent.pool.Pool(size = pool_size)
108113
self.pool_size = pool_size
109114
self.hosts = hosts

0 commit comments

Comments
 (0)