summaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-09-06 16:07:24 -0700
committerJeff Forcier <jeff@bitprophet.org>2014-09-06 16:07:24 -0700
commit08239ff4b29c0b53c5443f21ae482e51340223f6 (patch)
tree73f0b7e4d25a80c965186d03abde9c006b1feec0 /README
parent5335d9dc0a6266217d288e7aaf2091739980d841 (diff)
parent6a6ac4d78421667b810f5e3a017fb669853133f9 (diff)
Merge branch 'master' into 234-int
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 6 insertions, 7 deletions
diff --git a/README b/README
index 1899819a..61c5c852 100644
--- a/README
+++ b/README
@@ -5,7 +5,7 @@ paramiko
:Paramiko: Python SSH module
:Copyright: Copyright (c) 2003-2009 Robey Pointer <robeypointer@gmail.com>
-:Copyright: Copyright (c) 2013 Jeff Forcier <jeff@bitprophet.org>
+:Copyright: Copyright (c) 2013-2014 Jeff Forcier <jeff@bitprophet.org>
:License: LGPL
:Homepage: https://github.com/paramiko/paramiko/
:API docs: http://docs.paramiko.org
@@ -15,7 +15,7 @@ What
----
"paramiko" is a combination of the esperanto words for "paranoid" and
-"friend". it's a module for python 2.5+ that implements the SSH2 protocol
+"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
@@ -34,8 +34,10 @@ that should have come with this archive.
Requirements
------------
- - python 2.5 or better <http://www.python.org/>
+ - Python 2.6 or better <http://www.python.org/> - this includes Python
+ 3.2 and higher as well.
- pycrypto 2.1 or better <https://www.dlitz.net/software/pycrypto/>
+ - ecdsa 0.9 or better <https://pypi.python.org/pypi/ecdsa>
If you have setuptools, you can build and install paramiko and all its
dependencies with this command (as root)::
@@ -123,10 +125,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 epydoc, in the doc/
-folder. point your browser there. seriously, do it. mad props to
-epydoc, which actually motivated me to write more documentation than i
-ever would have before.
+there is also a lot of documentation, generated with Sphinx autodoc, in the doc/ folder.
there are also unit tests here::