summaryrefslogtreecommitdiff
path: root/paramiko/__init__.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-03-03 18:24:04 -0800
committerJeff Forcier <jeff@bitprophet.org>2014-03-03 18:24:04 -0800
commit72a73f55fae697fe3b940f378664a7c58214647f (patch)
tree553609aaa777980503536d76f074b74e1a3551ba /paramiko/__init__.py
parent4e9af2f7ca91613ea4c60ca22b96adc2247b1ba2 (diff)
parentc0fcd11ea0074d8cd019ed7087282754ea3ff792 (diff)
downloadparamiko-72a73f55fae697fe3b940f378664a7c58214647f.tar.gz
Merge branch '1.10' into 1.11
Conflicts: fabfile.py paramiko/__init__.py
Diffstat (limited to 'paramiko/__init__.py')
-rw-r--r--paramiko/__init__.py43
1 files changed, 1 insertions, 42 deletions
diff --git a/paramiko/__init__.py b/paramiko/__init__.py
index eba9f608..ada1fbd8 100644
--- a/paramiko/__init__.py
+++ b/paramiko/__init__.py
@@ -16,44 +16,10 @@
# along with Paramiko; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
-"""
-I{Paramiko} (a combination of the esperanto words for "paranoid" and "friend")
-is a module for python 2.5 or greater that implements the SSH2 protocol for
-secure (encrypted and authenticated) connections to remote machines. Unlike
-SSL (aka TLS), the SSH2 protocol does not require hierarchical certificates
-signed by a powerful central authority. You may know SSH2 as the protocol that
-replaced C{telnet} and C{rsh} for secure access to remote shells, but the
-protocol also includes the ability to open arbitrary channels to remote
-services across an encrypted tunnel. (This is how C{sftp} works, for example.)
-
-The high-level client API starts with creation of an L{SSHClient} object.
-For more direct control, pass a socket (or socket-like object) to a
-L{Transport}, and use L{start_server <Transport.start_server>} or
-L{start_client <Transport.start_client>} to negoatite
-with the remote host as either a server or client. As a client, you are
-responsible for authenticating using a password or private key, and checking
-the server's host key. I{(Key signature and verification is done by paramiko,
-but you will need to provide private keys and check that the content of a
-public key matches what you expected to see.)} As a server, you are
-responsible for deciding which users, passwords, and keys to allow, and what
-kind of channels to allow.
-
-Once you have finished, either side may request flow-controlled L{Channel}s to
-the other side, which are python objects that act like sockets, but send and
-receive data over the encrypted session.
-
-Paramiko is written entirely in python (no C or platform-dependent code) and is
-released under the GNU Lesser General Public License (LGPL).
-
-Website: U{https://github.com/paramiko/paramiko/}
-
-Mailing list: U{paramiko@librelist.com<mailto:paramiko@librelist.com>}
-"""
-
import sys
if sys.version_info < (2, 5):
- raise RuntimeError('You need python 2.5+ for this module.')
+ raise RuntimeError('You need Python 2.5+ for this module.')
__author__ = "Jeff Forcier <jeff@bitprophet.org>"
@@ -88,13 +54,6 @@ from hostkeys import HostKeys
from config import SSHConfig
from proxy import ProxyCommand
-# fix module names for epydoc
-for c in locals().values():
- if issubclass(type(c), type) or type(c).__name__ == 'classobj':
- # classobj for exceptions :/
- c.__module__ = __name__
-del c
-
from common import AUTH_SUCCESSFUL, AUTH_PARTIALLY_SUCCESSFUL, AUTH_FAILED, \
OPEN_SUCCEEDED, OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED, OPEN_FAILED_CONNECT_FAILED, \
OPEN_FAILED_UNKNOWN_CHANNEL_TYPE, OPEN_FAILED_RESOURCE_SHORTAGE