diff options
Diffstat (limited to 'sites/www/index.rst')
| -rw-r--r-- | sites/www/index.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/sites/www/index.rst b/sites/www/index.rst new file mode 100644 index 00000000..1b609709 --- /dev/null +++ b/sites/www/index.rst @@ -0,0 +1,36 @@ +Welcome to Paramiko! +==================== + +Paramiko is a Python (2.6+, 3.3+) implementation of the SSHv2 protocol [#]_, +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. + +This website covers project information for Paramiko such as the changelog, +contribution guidelines, development roadmap, news/blog, and so forth. Detailed +usage and API documentation can be found at our code documentation site, +`docs.paramiko.org <http://docs.paramiko.org>`_. + +Please see the sidebar to the left to begin. + +.. toctree:: + :hidden: + + changelog + FAQs <faq> + 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. |