1Installation
2============
3
4To install pyOpenSSL::
5
6  $ pip install pyopenssl
7
8If you are installing in order to *develop* on pyOpenSSL, move to the root directory of a pyOpenSSL checkout, and run::
9
10  $ pip install -e .
11
12
13.. warning::
14
15   As of 0.14, pyOpenSSL is a pure-Python project.
16   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.
17
18   Please take the time to read the errors and report them/ask help from the appropriate project.
19   The most likely culprit being `cryptography <https://cryptography.io/>`_ that contains OpenSSL's library bindings.
20
21
22Supported OpenSSL Versions
23--------------------------
24
25pyOpenSSL supports the same platforms and releases as the upstream cryptography project `does <https://cryptography.io/en/latest/installation/#supported-platforms>`_.
26Currently that means:
27
28- 1.0.2
29- 1.1.0
30- 1.1.1
31
32You can always find out the versions of pyOpenSSL, cryptography, and the linked OpenSSL by running ``python -m OpenSSL.debug``.
33
34
35Documentation
36-------------
37
38The documentation is written in reStructuredText and built using Sphinx::
39
40  $ cd doc
41  $ make html
42