dorian
/
paramiko
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

slight readme cleanup

This commit is contained in:
Robey Pointer 2011-05-21 19:30:06 -07:00
parent 5d9eeaedcc
commit a139d543ca
1 changed files with 11 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.rst
View File

@ -38,18 +38,9 @@ that should have come with this archive.
Requirements Requirements
------------ ------------
- python 2.3 <http://www.python.org/> - python 2.3 or better <http://www.python.org/>
(python 2.2 is also supported, but not recommended) (python 2.2 is also supported, but not recommended)
- pycrypto 1.9+ <http://www.amk.ca/python/code/crypto.html> - pycrypto 2.1 or better <https://www.dlitz.net/software/pycrypto/>
(2.0 works too)
pycrypto compiled for Win32 can be downloaded from the HashTar homepage:
http://nitace.bsd.uchicago.edu:8080/hashtar
you can also build it yourself using the free MinGW tools and this command
line (thanks to Roger Binns for the info)::
python setup.py build --compiler=mingw32 bdist_wininst
If you have setuptools, you can build and install paramiko and all its If you have setuptools, you can build and install paramiko and all its
dependencies with this command (as root):: dependencies with this command (as root)::
@ -60,34 +51,34 @@ dependencies with this command (as root)::
Portability Portability
----------- -----------
i code and test this library on Linux and MacOS X. for that reason, i'm i code and test this library on Linux and MacOS X. for that reason, i'm
pretty sure that it works for all posix platforms, including MacOS. it pretty sure that it works for all posix platforms, including MacOS. it
should also work on Windows, though i don't test it as frequently there. 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 if you run into Windows problems, send me a patch: portability is important
to me. to me.
python 2.2 may work, thanks to some patches from Roger Binns. things to python 2.2 may work, thanks to some patches from Roger Binns. things to
watch out for: watch out for:
* sockets in 2.2 don't support timeouts, so the 'select' module is * sockets in 2.2 don't support timeouts, so the 'select' module is
imported to do polling. imported to do polling.
* logging is mostly stubbed out. it works just enough to let paramiko * 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, 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 you can backport python 2.3's logging package. Roger has done that
already: already:
http://sourceforge.net/project/showfiles.php?group_id=75211&package_id=113804 http://sourceforge.net/project/showfiles.php?group_id=75211&package_id=113804
you really should upgrade to python 2.3. laziness is no excuse! :) you really should upgrade to python 2.3. laziness is no excuse! :)
some python distributions don't include the utf-8 string encodings, for some python distributions don't include the utf-8 string encodings, for
reasons of space (misdirected as that is). if your distribution is reasons of space (misdirected as that is). if your distribution is
missing encodings, you'll see an error like this:: missing encodings, you'll see an error like this::
LookupError: no codec search functions registered: can't find encoding LookupError: no codec search functions registered: can't find encoding
this means you need to copy string encodings over from a working system. this means you need to copy string encodings over from a working system.
(it probably only happens on embedded systems, not normal python (it probably only happens on embedded systems, not normal python
installs.) Valeriy Pogrebitskiy says the best place to look is installs.) Valeriy Pogrebitskiy says the best place to look is
``.../lib/python*/encodings/__init__.py``. ``.../lib/python*/encodings/__init__.py``.