updates python docs

wrapper/python/LICENSING.rst

@@ -1,30 +1,23 @@
 Licensing
-=========
+---------
 
 wolfSSL’s software is available under two distinct licensing models:
 open source and standard commercial licensing. Please see the relevant
 section below for information on each type of license.
 
 Open Source
------------
+~~~~~~~~~~~
 
-wolfSSL (formerly CyaSSL), yaSSL, wolfCrypt, yaSSH and TaoCrypt software
+wolfCrypt and wolfSSL software are free software downloads and may be modified
-are free software downloads and may be modified to the needs of the user
+to the needs of the user as long as the user adheres to version two of the GPL
-as long as the user adheres to version two of the GPL License. The GPLv2
+License. The GPLv2 license can be found on the `gnu.org website
-license can be found on the gnu.org website:
+<http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_.
-
-    http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 
 Commercial Licensing
---------------------
+~~~~~~~~~~~~~~~~~~~~
 
 Businesses and enterprises who wish to incorporate wolfSSL products into
 proprietary appliances or other commercial software products for
-re-distribution must license commercial versions. Commercial licenses for
+re-distribution must license commercial versions. Licenses are generally issued
-wolfSSL, yaSSL, and wolfCrypt are available for $5,000 USD per end product
+for one product and include unlimited royalty-free distribution. Custom
-or SKU. Licenses are generally issued for one product and include unlimited
+licensing terms are also available at licensing@wolfssl.com.
-royalty-free distribution. Custom licensing terms are also available.
-
-    Email: licensing@wolfssl.com
-
-    Phone: +1 425 245-8247

wrapper/python/README.rst

@@ -3,12 +3,25 @@
 wolfcrypt: the wolfSSL Crypto Engine
 ====================================
 
+**wolfCrypt Python**, a.k.a. ``wolfcrypt`` is a Python library that encapsulates
+**wolfSSL's wolfCrypt API**.
 
-A Python library that encapsulates wolfSSL's wolfCrypt API
+**wolfCrypt** is a lightweight, portable, C-language-based crypto library
+targeted at IoT, embedded, and RTOS environments primarily because of its size,
+speed, and feature set. It works seamlessly in desktop, enterprise, and cloud
+environments as well.
 
 
-1. Clone the repository and install wolfssl::
+Installation
+------------
 
+You can install ``wolfcrypt`` via ``pip`` or ``source code``, but before
+installing it, make sure you have ``wolfssl`` C library installed in your
+machine.
+
+To install wolfssl do:
+
+.. code-block:: console
 
     $ git clone git@github.com:wolfssl/wolfssl.git
     $ cd wolfssl
@@ -18,34 +31,68 @@ A Python library that encapsulates wolfSSL's wolfCrypt API
     $ sudo make install
 
 
-2. Make sure that ``cffi``, ``py.test``, and ``tox`` are installed::
+wolfcrypt pip installation
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To install ``wolfcrypt`` with ``pip``:
+
+.. code-block:: console
+
+    $ pip install wolfcrypt
+
+or if you need admin privileges to use ``pip``:
+
+.. code-block:: console
+
+    $ sudo -H pip install wolfcrypt
 
 
-    $ cd wrappers/python
+wolfcrypt source installation
-    $ pip install -r requirements-testing.txt
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+To install ``wolfcrypt`` from sources:
 
-3. Run ``python setup.py install`` to build and install wolfcrypt::
+1. Get the sources:
 
+.. code-block:: console
+
+    $ git clone git@github.com:wolfssl/wolfssl.git
+    $ cd wolfssl/wrappers/python
+
+2. Build and install ``wolfcrypt``
+
+.. code-block:: console
 
     $ python setup.py install
     ...
-    Finished processing dependencies for wolfcrypt==0.1.0
+    Finished processing dependencies for wolfcrypt...
+
+or if you need admin privileges to use the install command:
+
+.. code-block:: console
+
+    $ sudo python setup.py install
 
 
-4. Test locally with ``tox``::
+Testing
+-------
 
+Test ``wolfcrypt`` locally with ``tox``:
+
+1. Make sure that the testing requirements are installed:
+
+.. code-block:: console
+
+    $ pip install -r requirements-testing.txt
+
+
+2. Call ``tox``:
+
+.. code-block:: console
 
     $ tox
     ...
     _________________________________ summary _________________________________
-    py26: commands succeeded
     py27: commands succeeded
     py35: commands succeeded
     congratulations :)
-
-
-.. include:: LICENSING.rst
-
-
-Copyright 2016 wolfSSL Inc.  All rights reserved.

wrapper/python/docs/index.rst

@@ -1,13 +1,4 @@
-wolfCrypt Python Documentation
+.. include:: ../README.rst
-==================================
-
-**wolfCrypt Python**, a.k.a. ``wolfcrypt`` is a Python library that encapsulates
-**wolfSSL's wolfCrypt API**.
-
-**wolfCrypt** is a lightweight, portable, C-language-based crypto library
-targeted at IoT, embedded, and RTOS environments primarily because of its size,
-speed, and feature set. It works seamlessly in desktop, enterprise, and cloud
-environments as well.
 
 Summary
 -------
@@ -21,26 +12,4 @@ Summary
    mac
    random
 
-Licensing
+.. include:: ../LICENSING.rst
----------
-
-wolfSSL’s software is available under two distinct licensing models:
-open source and standard commercial licensing. Please see the relevant
-section below for information on each type of license.
-
-Open Source
-~~~~~~~~~~~
-
-wolfCrypt and wolfSSL software are free software downloads and may be modified
-to the needs of the user as long as the user adheres to version two of the GPL
-License. The GPLv2 license can be found on the `gnu.org website
-<http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_.
-
-Commercial Licensing
-~~~~~~~~~~~~~~~~~~~~
-
-Businesses and enterprises who wish to incorporate wolfSSL products into
-proprietary appliances or other commercial software products for
-re-distribution must license commercial versions. Licenses are generally issued
-for one product and include unlimited royalty-free distribution. Custom
-licensing terms are also available at licensing@wolfssl.com.