aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 8 insertions, 32 deletions
diff --git a/README b/README
index f977c6d..68e7434 100644
--- a/README
+++ b/README
@@ -5,21 +5,16 @@ paramiko
:Paramiko: Python SSH module
:Copyright: Copyright (c) 2003-2009 Robey Pointer <robeypointer@gmail.com>
+:Copyright: Copyright (c) 2013 Jeff Forcier <jeff@bitprophet.org>
:License: LGPL
-:Homepage: http://www.lag.net/paramiko/
-
-
-paramiko 1.7.7.1
-================
-
-"George" release, 21 may 2011
+:Homepage: https://github.com/paramiko/paramiko/
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.5+ 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
@@ -38,8 +33,7 @@ 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.5 or better <http://www.python.org/>
- pycrypto 2.1 or better <https://www.dlitz.net/software/pycrypto/>
If you have setuptools, you can build and install paramiko and all its
@@ -57,19 +51,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::
@@ -85,15 +66,7 @@ installs.) Valeriy Pogrebitskiy says the best place to look is
Bugs & Support
--------------
-there's a launchpage page for paramiko, with a bug tracker:
-
- https://launchpad.net/paramiko/
-
-this is the primary place to file and browse bug reports.
-
-there's also a low-traffic mailing list for support and discussions:
-
- http://www.lag.net/mailman/listinfo/paramiko
+Please file bug reports at https://github.com/paramiko/paramiko/. There is currently no mailing list but we plan to create a new one ASAP.
Demo
@@ -141,6 +114,9 @@ the following example scripts (in demos/) get progressively more detailed:
'robey' (password 'foo'), and pretends to be a BBS. meant to be a
very simple demo of writing an ssh server.
+:demo_keygen.py:
+ an key generator similar to openssh ssh-keygen(1) program with
+ paramiko keys generation and progress functions.
Use
---