| Julia Hansbrough | b65223d | 2015-04-13 17:30:58 -0400 | [diff] [blame] | 1 | Installation |
| 2 | ============ |
| 3 | |
| 4 | To install pyOpenSSL:: |
| 5 | |
| 6 | $ pip install pyopenssl |
| 7 | |
| 8 | If 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 | |
| Hynek Schlawack | 930525d | 2015-06-28 13:34:41 +0200 | [diff] [blame] | 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 | |
| Julia Hansbrough | b65223d | 2015-04-13 17:30:58 -0400 | [diff] [blame] | 22 | Documentation |
| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 23 | ------------- |
| Julia Hansbrough | b65223d | 2015-04-13 17:30:58 -0400 | [diff] [blame] | 24 | |
| 25 | The documentation is written in reStructuredText and built using Sphinx:: |
| 26 | |
| 27 | $ cd doc |
| 28 | $ make html |