summaryrefslogtreecommitdiffhomepage
path: root/site/index.rst
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-01-10 19:26:04 -0800
committerJeff Forcier <jeff@bitprophet.org>2014-01-21 16:14:26 -0800
commitc74ff2a16e47bdf31f8ad17bbfbe2da5d03803c6 (patch)
tree59b1240b3328640776448a4f717f6bb51fd91d15 /site/index.rst
parent5c5bf6e844d63a14f586d9166c536ab0978b684b (diff)
Import paramiko.org repository @ 3ac370054ef10fb060fe75fff25fe3a70ecc02c0
Diffstat (limited to 'site/index.rst')
-rw-r--r--site/index.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/site/index.rst b/site/index.rst
new file mode 100644
index 00000000..7d203b62
--- /dev/null
+++ b/site/index.rst
@@ -0,0 +1,31 @@
+Welcome to Paramiko!
+====================
+
+Paramiko is a Python (2.5+) 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 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>`_.
+
+.. toctree::
+ blog
+ 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.