summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHynek Schlawack <hs@ox.cx>2015-06-07 19:09:49 +0200
committerHynek Schlawack <hs@ox.cx>2015-06-07 19:14:22 +0200
commit8fb864a305841d4013950651250737f78a1ae2f1 (patch)
tree6eff560176d8531acfbfa711e0a65e8894dd8d95 /doc
parentc9dbaab97543418212e3d660e9140f866e055c49 (diff)
downloadpyopenssl-git-8fb864a305841d4013950651250737f78a1ae2f1.tar.gz
Update contributing & policy information
Diffstat (limited to 'doc')
-rw-r--r--doc/index.rst13
-rw-r--r--doc/install.rst1
-rw-r--r--doc/introduction.rst43
3 files changed, 40 insertions, 17 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 7006ec6..4c15fc8 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,22 +1,25 @@
+=====================================
Welcome to pyOpenSSL's documentation!
=====================================
-.. topic:: Abstract
- This module is a rather thin wrapper around (a subset of) the OpenSSL library.
- With thin wrapper I mean that a lot of the object methods do nothing more than
- calling a corresponding function in the OpenSSL library.
+pyOpenSSL is a rather thin wrapper around (a subset of) the OpenSSL library.
+With thin wrapper we mean that a lot of the object methods do nothing more than
+calling a corresponding function in the OpenSSL library.
Contents:
+=========
.. toctree::
- :maxdepth: 3
+ :maxdepth: 2
introduction
+ install
api
internals
+
Indices and tables
==================
diff --git a/doc/install.rst b/doc/install.rst
new file mode 100644
index 0000000..a23a75e
--- /dev/null
+++ b/doc/install.rst
@@ -0,0 +1 @@
+.. include:: ../INSTALL.rst
diff --git a/doc/introduction.rst b/doc/introduction.rst
index c29f80c..41f8e59 100644
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -1,17 +1,36 @@
.. _intro:
+============
Introduction
============
-The reason pyOpenSSL was created is that the SSL support in the socket module in
-Python 2.1 (the contemporary version of Python when the pyOpenSSL project was
-begun) was severely limited. Other OpenSSL wrappers for Python at the time were
-also limited, though in different ways. Unfortunately, Python's standard
-library SSL support has remained weak, although other packages (such as
-`M2Crypto <http://chandlerproject.org/Projects/MeTooCrypto>`_)
-have made great advances and now equal or exceed pyOpenSSL's functionality.
-
-The reason pyOpenSSL continues to be maintained is that there is a significant
-user community around it, as well as a large amount of software which depends on
-it. It is a great benefit to many people for pyOpenSSL to continue to exist and
-advance.
+
+History
+=======
+
+pyOpenSSL was originally created by Martin Sjögren because the SSL support in the standard library in Python 2.1 (the contemporary version of Python when the pyOpenSSL project was begun) was severely limited.
+Other OpenSSL wrappers for Python at the time were also limited, though in different ways.
+
+Later it was maintained by `Jean-Paul Calderone`_ who among other things managed to make pyOpenSSL a pure Python project which the current maintainers are *very* grateful for.
+
+Over the time the standard library's ``ssl`` module improved, never reaching the completeness of pyOpenSSL's API coverage.
+Despite `PEP 466`_ many useful features remain Python 3-only and pyOpenSSL remains the only alternative for full-featured TLS code across all noteworthy Python versions from 2.6 through 3.4 and PyPy_.
+
+
+Development
+===========
+
+pyOpenSSL is collaboratively developed by the Python Cryptography Authority (PyCA_) that also maintains the low-level bindings called cryptography_.
+
+Current maintainer and release manager is `Hynek Schlawack`_.
+
+
+.. include:: ../CONTRIBUTING.rst
+
+
+.. _Jean-Paul Calderone: https://github.com/exarkun
+.. _PyPy: http://pypy.org
+.. _PEP 466: https://www.python.org/dev/peps/pep-0466/
+.. _PyCA: https://github.com/pyca
+.. _cryptography: https://github.com/pyca/cryptography
+.. _Hynek Schlawack: https://hynek.me/