=====================================
Welcome to pyOpenSSL's documentation!
=====================================

Release v\ |release| (:doc:`What's new? <changelog>`).

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: 2

   introduction
   install
   api
   internals

There are also `examples in the pyOpenSSL repository <https://github.com/pyca/pyopenssl/tree/master/examples>`_ that may help you getting started.


Meta
----

.. toctree::
   :maxdepth: 1

   backward-compatibility
   changelog


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`