README.rst 1.8 KB

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