2014-01-10 22:26:04 -05:00
|
|
|
Welcome to Paramiko!
|
|
|
|
|
====================
|
|
|
|
|
|
2014-03-14 00:05:32 -04:00
|
|
|
Paramiko is a Python (2.6+, 3.3+) implementation of the SSHv2 protocol [#]_,
|
2014-01-10 22:26:04 -05:00
|
|
|
providing both client and server functionality. While it leverages a Python C
|
|
|
|
|
extension for low level cryptography (`PyCrypto <http://pycrypto.org>`_),
|
|
|
|
|
Paramiko itself is a pure Python interface around SSH networking concepts.
|
|
|
|
|
|
2014-01-22 15:48:32 -05:00
|
|
|
This website covers project information for Paramiko such as the changelog,
|
|
|
|
|
contribution guidelines, development roadmap, news/blog, and so forth. Detailed
|
2014-01-10 22:26:04 -05:00
|
|
|
usage and API documentation can be found at our code documentation site,
|
|
|
|
|
`docs.paramiko.org <http://docs.paramiko.org>`_.
|
|
|
|
|
|
2014-04-06 19:25:02 -04:00
|
|
|
Please see the sidebar to the left to begin.
|
2014-04-06 19:24:16 -04:00
|
|
|
|
2014-01-10 22:26:04 -05:00
|
|
|
.. toctree::
|
2014-04-06 19:19:03 -04:00
|
|
|
:hidden:
|
|
|
|
|
|
2014-01-22 15:48:32 -05:00
|
|
|
changelog
|
2014-03-21 20:32:36 -04:00
|
|
|
FAQs <faq>
|
2014-01-10 22:26:04 -05:00
|
|
|
installing
|
|
|
|
|
contributing
|
|
|
|
|
contact
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. rubric:: Footnotes
|
|
|
|
|
|
|
|
|
|
.. [#]
|
|
|
|
|
SSH is defined in RFCs
|
|
|
|
|
`4251 <http://www.rfc-editor.org/rfc/rfc4251.txt>`_,
|
|
|
|
|
`4252 <http://www.rfc-editor.org/rfc/rfc4252.txt>`_,
|
|
|
|
|
`4253 <http://www.rfc-editor.org/rfc/rfc4253.txt>`_, and
|
|
|
|
|
`4254 <http://www.rfc-editor.org/rfc/rfc4254.txt>`_;
|
|
|
|
|
the primary working implementation of the protocol is the `OpenSSH project
|
|
|
|
|
<http://openssh.org>`_. Paramiko implements a large portion of the SSH
|
|
|
|
|
feature set, but there are occasional gaps.
|
