blob: 36046caa3feff3ba348867dc87c3a7d395732dd5 [file] [log] [blame]
Hynek Schlawack65e4def2016-03-13 15:07:52 +01001========================================================
Hynek Schlawack5bc17cb2015-04-30 19:21:40 +02002pyOpenSSL -- A Python wrapper around the OpenSSL library
Hynek Schlawack65e4def2016-03-13 15:07:52 +01003========================================================
Paul Kehrer158f5692015-04-15 10:31:36 -04004
Hynek Schlawackac7fbb82016-03-19 07:42:15 +01005.. image:: https://readthedocs.org/projects/pyopenssl/badge/?version=stable
Hynek Schlawack81021282017-07-20 10:32:37 +02006 :target: https://pyopenssl.org/en/stable/
Hynek Schlawackac7fbb82016-03-19 07:42:15 +01007 :alt: Stable Docs
Paul Kehrer158f5692015-04-15 10:31:36 -04008
9.. image:: https://travis-ci.org/pyca/pyopenssl.svg?branch=master
Hynek Schlawackb3b27652015-07-03 16:50:27 +020010 :target: https://travis-ci.org/pyca/pyopenssl
11 :alt: Build status
12
Hynek Schlawackf6c96af2017-04-20 12:34:58 +020013.. image:: https://codecov.io/github/pyca/pyopenssl/branch/master/graph/badge.svg
Hynek Schlawackb3b27652015-07-03 16:50:27 +020014 :target: https://codecov.io/github/pyca/pyopenssl
15 :alt: Test coverage
Jean-Paul Calderone897bc252008-02-18 20:50:23 -050016
Hynek Schlawack5bc17cb2015-04-30 19:21:40 +020017
18High-level wrapper around a subset of the OpenSSL library. Includes
19
Hynek Schlawackac7fbb82016-03-19 07:42:15 +010020* ``SSL.Connection`` objects, wrapping the methods of Python's portable sockets
Hynek Schlawack5bc17cb2015-04-30 19:21:40 +020021* Callbacks written in Python
22* Extensive error-handling mechanism, mirroring OpenSSL's error codes
23
24... and much more.
25
Hynek Schlawackac7fbb82016-03-19 07:42:15 +010026You can find more information in the documentation_.
27Development takes place on GitHub_.
Jean-Paul Calderone26918492014-02-02 15:59:19 -050028
Ewoud Kohl van Wijngaarden99d1f9b2014-06-16 10:45:25 +020029
Hynek Schlawackac7fbb82016-03-19 07:42:15 +010030Discussion
31==========
Jean-Paul Calderone26918492014-02-02 15:59:19 -050032
Hynek Schlawackac7fbb82016-03-19 07:42:15 +010033If you run into bugs, you can file them in our `issue tracker`_.
34
35We maintain a cryptography-dev_ mailing list for both user and development discussions.
36
37You can also join ``#cryptography-dev`` on Freenode to ask questions or get involved.
38
39
Hynek Schlawack81021282017-07-20 10:32:37 +020040.. _documentation: https://pyopenssl.org/
Hynek Schlawackac7fbb82016-03-19 07:42:15 +010041.. _`issue tracker`: https://github.com/pyca/pyopenssl/issues
42.. _cryptography-dev: https://mail.python.org/mailman/listinfo/cryptography-dev
43.. _GitHub: https://github.com/pyca/pyopenssl