aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 5 insertions, 7 deletions
diff --git a/README b/README
index 2a23e28..9305bfb 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,7 +34,8 @@ 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.3 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>
@@ -124,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::