1========================================================
2pyOpenSSL -- A Python wrapper around the OpenSSL library
3========================================================
4
5.. image:: https://readthedocs.org/projects/pyopenssl/badge/?version=stable
6   :target: https://pyopenssl.org/en/stable/
7   :alt: Stable Docs
8
9.. image:: https://travis-ci.com/pyca/pyopenssl.svg?branch=master
10   :target: https://travis-ci.com/pyca/pyopenssl
11   :alt: Build status
12
13.. image:: https://codecov.io/github/pyca/pyopenssl/branch/master/graph/badge.svg
14   :target: https://codecov.io/github/pyca/pyopenssl
15   :alt: Test coverage
16
17**Note:** The Python Cryptographic Authority **strongly suggests** the use of `pyca/cryptography`_
18where possible. If you are using pyOpenSSL for anything other than making a TLS connection
19**you should move to cryptography and drop your pyOpenSSL dependency**.
20
21High-level wrapper around a subset of the OpenSSL library. Includes
22
23* ``SSL.Connection`` objects, wrapping the methods of Python's portable sockets
24* Callbacks written in Python
25* Extensive error-handling mechanism, mirroring OpenSSL's error codes
26
27... and much more.
28
29You can find more information in the documentation_.
30Development takes place on GitHub_.
31
32
33Discussion
34==========
35
36If you run into bugs, you can file them in our `issue tracker`_.
37
38We maintain a cryptography-dev_ mailing list for both user and development discussions.
39
40You can also join ``#cryptography-dev`` on Freenode to ask questions or get involved.
41
42
43.. _documentation: https://pyopenssl.org/
44.. _`issue tracker`: https://github.com/pyca/pyopenssl/issues
45.. _cryptography-dev: https://mail.python.org/mailman/listinfo/cryptography-dev
46.. _GitHub: https://github.com/pyca/pyopenssl
47.. _`pyca/cryptography`: https://github.com/pyca/cryptography
48