88that encapsulates `wolfSSL's SSL/TLS library
99<https://wolfssl.com/wolfSSL/Products-wolfssl.html> `_.
1010
11- **wolfSSL's SSL/TLS library ** is a lightweight, portable, C-language-based
11+ The **wolfSSL SSL/TLS library ** is a lightweight, portable, C-language-based
1212library targeted at IoT, embedded, and RTOS environments primarily because of
1313its size, speed, and feature set. It works seamlessly in desktop, enterprise,
1414and cloud environments as well.
@@ -22,3 +22,42 @@ We provide Python wheels (prebuilt binaries) for OSX 64 bits and Linux 64 bits:
2222.. code-block :: bash
2323
2424 $ pip install wolfssl
25+
26+ To build wolfssl-py from source:
27+
28+ .. code-block :: bash
29+
30+ $ cd wolfssl-py
31+ $ pip install .
32+
33+ The default pip install clones wolfSSL from GitHub. To build wolfssl-py using a
34+ local installation of the native wolfSSL C library, the USE_LOCAL_WOLFSSL
35+ environment variable should be set. USE_LOCAL_WOLFSSL can be set to "1" to use
36+ the default library installation location (/usr/local/lib, /usr/local/include),
37+ or to use a custom location it can be set to the install locaiton of your native
38+ wolfSSL library. For example:
39+
40+ .. code-block :: bash
41+
42+ # Uses default install location
43+ $ USE_LOCAL_WOLFSSL=1 pip install .
44+
45+ # Uses custom install location
46+ $ USE_LOCAL_WOLFSSL=/tmp/install pip install .
47+
48+ Tests
49+ =====
50+
51+ To run the tests that ship with wolfssl-py, after compiling the library run
52+ one of the following commands:
53+
54+ .. code-block :: bash
55+
56+ $ pytest
57+ $ py.test tests
58+
59+ Support
60+ =======
61+
62+ For support and questions, please email support@wolfssl.com.
63+
0 commit comments