summaryrefslogtreecommitdiffhomepage
path: root/README.rst
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2017-06-06 12:31:57 -0700
committerJeff Forcier <jeff@bitprophet.org>2017-06-06 12:31:57 -0700
commita2da21d46bb9a441dbb8da570262bb424e1f9450 (patch)
tree8e1c7bdd402fb640f75b061bc2051f5fe6eba676 /README.rst
parent79fcbdad812cc3be39afbf8375c11e0581eeb86e (diff)
parentd285b80ecb6102b0ad501b74d02e04d61e8ec632 (diff)
Merge branch '2.0' into 667-int
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst51
1 files changed, 22 insertions, 29 deletions
diff --git a/README.rst b/README.rst
index 3ed9e7bc..e267f69a 100644
--- a/README.rst
+++ b/README.rst
@@ -11,7 +11,7 @@ Paramiko
:Paramiko: Python SSH module
:Copyright: Copyright (c) 2003-2009 Robey Pointer <robeypointer@gmail.com>
-:Copyright: Copyright (c) 2013-2016 Jeff Forcier <jeff@bitprophet.org>
+:Copyright: Copyright (c) 2013-2017 Jeff Forcier <jeff@bitprophet.org>
:License: `LGPL <https://www.gnu.org/copyleft/lesser.html>`_
:Homepage: http://www.paramiko.org/
:API docs: http://docs.paramiko.org
@@ -21,30 +21,22 @@ Paramiko
What
----
-"Paramiko" is a combination of the esperanto words for "paranoid" and
-"friend". It's a module for Python 2.6+ that implements the SSH2 protocol
-for secure (encrypted and authenticated) connections to remote machines.
-Unlike SSL (aka TLS), SSH2 protocol does not require hierarchical
-certificates signed by a powerful central authority. You may know SSH2 as
-the protocol that replaced Telnet and rsh for secure access to remote
-shells, but the protocol also includes the ability to open arbitrary
-channels to remote services across the encrypted tunnel (this is how SFTP
-works, for example).
-
-It is written entirely in Python (no C or platform-dependent code) and is
-released under the GNU Lesser General Public License (`LGPL
+"Paramiko" is a combination of the Esperanto words for "paranoid" and
+"friend". It's a module for Python 2.6+/3.3+ that implements the SSH2 protocol
+for secure (encrypted and authenticated) connections to remote machines. Unlike
+SSL (aka TLS), SSH2 protocol does not require hierarchical certificates signed
+by a powerful central authority. You may know SSH2 as the protocol that
+replaced Telnet and rsh for secure access to remote shells, but the protocol
+also includes the ability to open arbitrary channels to remote services across
+the encrypted tunnel (this is how SFTP works, for example).
+
+It is written entirely in Python (though it depends on third-party C wrappers
+for low level crypto; these are often available precompiled) and is released
+under the GNU Lesser General Public License (`LGPL
<https://www.gnu.org/copyleft/lesser.html>`_).
-The package and its API is fairly well documented in the "doc/" folder
-that should have come with this archive.
-
-
-Requirements
-------------
-
-- `Python <http://www.python.org/>`_ 2.6, 2.7, or 3.3+
-- `Cryptography <https://cryptography.io>`_ 0.8 or better
-- `pyasn1 <https://pypi.python.org/pypi/pyasn1>`_ 0.1.7 or better
+The package and its API is fairly well documented in the ``docs`` folder that
+should have come with this repository.
Installation
@@ -87,20 +79,21 @@ Demo
----
Several demo scripts come with Paramiko to demonstrate how to use it.
-Probably the simplest demo of all is this::
+Probably the simplest demo is this::
- import paramiko, base64
- key = paramiko.RSAKey(data=base64.decodestring('AAA...'))
+ import base64
+ import paramiko
+ key = paramiko.RSAKey(data=base64.b64decode(b'AAA...'))
client = paramiko.SSHClient()
client.get_host_keys().add('ssh.example.com', 'ssh-rsa', key)
client.connect('ssh.example.com', username='strongbad', password='thecheat')
stdin, stdout, stderr = client.exec_command('ls')
for line in stdout:
- print '... ' + line.strip('\n')
+ print('... ' + line.strip('\n'))
client.close()
This prints out the results of executing ``ls`` on a remote server. The host
-key 'AAA...' should of course be replaced by the actual base64 encoding of the
+key ``b'AAA...'`` should of course be replaced by the actual base64 encoding of the
host key. If you skip host key verification, the connection is not secure!
The following example scripts (in demos/) get progressively more detailed:
@@ -134,7 +127,7 @@ Use
---
The demo scripts are probably the best example of how to use this package.
-There is also a lot of documentation, generated with Sphinx autodoc, in the
+Also a lot of documentation is generated by Sphinx autodoc, in the
doc/ folder.
There are also unit tests here::