diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2015-05-08 10:34:37 -0400 |
---|---|---|
committer | Jason R. Coombs <jaraco@jaraco.com> | 2015-05-08 10:34:37 -0400 |
commit | 1f262db4040328572565bfdac4b435fd19afaae1 (patch) | |
tree | d8a3a9036ba18a3a0083cbe1e3a85e3dce756c66 /README | |
parent | f2213b8a40c652780c209071574e4c85a8480eb3 (diff) | |
parent | 7400ce4fd80fc6c0cfc1b3d96900ee2fb87f9ebe (diff) |
Merge with 1.13
Diffstat (limited to 'README')
-rw-r--r-- | README | 34 |
1 files changed, 7 insertions, 27 deletions
@@ -5,22 +5,17 @@ paramiko :Paramiko: Python SSH module :Copyright: Copyright (c) 2003-2009 Robey Pointer <robeypointer@gmail.com> -:Copyright: Copyright (c) 2012 Jeff Forcier <jeff@bitprophet.org> +:Copyright: Copyright (c) 2013-2015 Jeff Forcier <jeff@bitprophet.org> :License: LGPL :Homepage: https://github.com/paramiko/paramiko/ - - -paramiko 1.8.0 -============== - -Release of MM.YY.DD +:API docs: http://docs.paramiko.org What ---- "paramiko" is a combination of the esperanto words for "paranoid" and -"friend". it's a module for python 2.2+ 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 @@ -39,9 +34,10 @@ that should have come with this archive. Requirements ------------ - - python 2.3 or better <http://www.python.org/> - (python 2.2 is also supported, but not recommended) + - 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):: @@ -58,19 +54,6 @@ should also work on Windows, though i don't test it as frequently there. if you run into Windows problems, send me a patch: portability is important to me. -python 2.2 may work, thanks to some patches from Roger Binns. things to -watch out for: - - * sockets in 2.2 don't support timeouts, so the 'select' module is - imported to do polling. - * logging is mostly stubbed out. it works just enough to let paramiko - create log files for debugging, if you want them. to get real logging, - you can backport python 2.3's logging package. Roger has done that - already: - http://sourceforge.net/project/showfiles.php?group_id=75211&package_id=113804 - -you really should upgrade to python 2.3. laziness is no excuse! :) - some python distributions don't include the utf-8 string encodings, for reasons of space (misdirected as that is). if your distribution is missing encodings, you'll see an error like this:: @@ -142,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:: |