INSTALL.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. Installation
  2. ============
  3. To install pyOpenSSL::
  4. $ pip install pyopenssl
  5. If you are installing in order to *develop* on pyOpenSSL, move to the root directory of a pyOpenSSL checkout, and run::
  6. $ pip install -e .
  7. .. warning::
  8. As of 0.14, pyOpenSSL is a pure-Python project.
  9. That means that if you encounter *any* kind of compiler errors, pyOpenSSL's bugtracker is the **wrong** place to report them because we *cannot* help you.
  10. Please take the time to read the errors and report them/ask help from the appropriate project.
  11. The most likely culprit being `cryptography <https://cryptography.io/>`_ that contains OpenSSL's library bindings.
  12. Supported OpenSSL Versions
  13. --------------------------
  14. pyOpenSSL supports the same platforms and releases as the upstream cryptography project `does <https://cryptography.io/en/latest/installation/#supported-platforms>`_.
  15. Currently that means:
  16. - 1.0.1
  17. - 1.0.2
  18. - 1.1.0
  19. If you need support for older releases, the following pinned versions will work:
  20. - **OpenSSL 0.9.8**: ``'pyOpenSSL<17.0' 'cryptography<1.4'``
  21. - **OpenSSL 1.0.0**: ``'pyOpenSSL<17.1' 'cryptography<1.7'``
  22. You can always find out the versions of pyOpenSSL, cryptography, and the linked OpenSSL by running ``python -m OpenSSL.debug``.
  23. Documentation
  24. -------------
  25. The documentation is written in reStructuredText and built using Sphinx::
  26. $ cd doc
  27. $ make html