|
1 | 1 | Welcome |
2 | 2 | ======= |
3 | 3 |
|
4 | | -``wolfssl Python`` is a Python module that encapsulates ``wolfssl C``, a `lightweight C-language-based SSL/TLS library <https://wolfssl.com/wolfSSL/Products-wolfssl.html>`_ targeted for embedded, RTOS, or |
5 | | -resource-constrained environments primarily because of its small size, speed, |
6 | | -and portability. |
| 4 | +.. image:: https://travis-ci.org/wolfSSL/wolfssl-py.svg?branch=master |
| 5 | + :target: https://travis-ci.org/wolfSSL/wolfssl-py |
7 | 6 |
|
8 | | -Installation |
9 | | -============ |
10 | | - |
11 | | -In order to use ``wolfssl Python``, you'll also need to install ``wolfssl C``. |
12 | | - |
13 | | -Mac OSX |
14 | | -------- |
15 | | - |
16 | | -Installing from ``homebrew`` and ``pip`` package managers: |
17 | | - |
18 | | -.. code-block:: shell |
19 | | -
|
20 | | - # wolfssl C installation |
21 | | - brew install wolfssl |
22 | | -
|
23 | | - # wolfssl Python installation |
24 | | - sudo -H pip install wolfssl |
25 | | -
|
26 | | -Installing from ``source code``: |
27 | | - |
28 | | -.. code-block:: shell |
29 | | -
|
30 | | - # wolfssl C installation |
31 | | - git clone https://github.com/wolfssl/wolfssl.git |
32 | | - cd wolfssl/ |
33 | | - ./autogen.sh |
34 | | - ./configure --enable-sha512 |
35 | | - make |
36 | | - sudo make install |
37 | | -
|
38 | | - # wolfssl Python installation |
39 | | - cd wrapper/python/wolfssl |
40 | | - sudo make install |
41 | | -
|
42 | | -
|
43 | | -Linux |
44 | | ------ |
| 7 | +**wolfSSL Python**, a.k.a. ``wolfssl`` is a Python module |
| 8 | +that encapsulates `wolfSSL's SSL/TLS library |
| 9 | +<https://wolfssl.com/wolfSSL/Products-wolfssl.html>`_. |
45 | 10 |
|
46 | | -.. code-block:: shell |
| 11 | +**wolfSSL's SSL/TLS library** is a lightweight, portable, C-language-based |
| 12 | +library targeted at IoT, embedded, and RTOS environments primarily because of |
| 13 | +its size, speed, and feature set. It works seamlessly in desktop, enterprise, |
| 14 | +and cloud environments as well. |
47 | 15 |
|
48 | | - # dependencies installation |
49 | | - sudo apt-get update |
50 | | - sudo apt-get install -y git autoconf libtool |
51 | | - sudo apt-get install -y python-dev python3-dev python-pip libffi-dev |
52 | 16 |
|
53 | | - # wolfssl C installation |
54 | | - git clone https://github.com/wolfssl/wolfssl.git |
55 | | - cd wolfssl/ |
56 | | - ./autogen.sh |
57 | | - ./configure --enable-sha512 |
58 | | - make |
59 | | - sudo make install |
60 | | -
|
61 | | - sudo ldconfig |
62 | | -
|
63 | | - # wolfssl Python installation |
64 | | - sudo -H pip install wolfssl |
65 | | -
|
66 | | -
|
67 | | -Testing |
68 | | -======= |
69 | | - |
70 | | -To run the tox tests in the source code, you'll need ``tox`` and a few other |
71 | | -requirements. The source code relies at **WOLFSSL_DIR/wrapper/python/wolfssl** |
72 | | -where **WOLFSSL_DIR** is the path of ``wolfssl C``'s source code. |
73 | | - |
74 | | -1. Make sure that the testing requirements are installed: |
75 | | - |
76 | | -.. code-block:: shell |
77 | | -
|
78 | | - sudo -H pip install -r requirements-testing.txt |
79 | | -
|
80 | | -
|
81 | | -2. Run ``make check``: |
| 17 | +Installation |
| 18 | +============ |
82 | 19 |
|
83 | | -.. code-block:: console |
| 20 | +We provide Python wheels (prebuilt binaries) for OSX 64 bits and Linux 64 bits: |
84 | 21 |
|
85 | | - $ make check |
86 | | - ... |
87 | | - _________________________________ summary _________________________________ |
88 | | - py27: commands succeeded |
89 | | - SKIPPED: py34: InterpreterNotFound: python3.4 |
90 | | - py35: commands succeeded |
91 | | - py36: commands succeeded |
92 | | - congratulations :) |
| 22 | +.. code-block:: bash |
93 | 23 |
|
94 | | -Note: the test is performed using multiple versions of python. If you are |
95 | | -missing a version the test will be skipped with an **InterpreterNotFound |
96 | | -error**. |
| 24 | + $ pip install wolfssl |
0 commit comments