updates readme
Moisés Guimarães
parent
6574ee4a5f
commit
3c6aaff373
|
|
@ -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
|
||||
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
|
||||
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. Commercial licenses for
|
||||
wolfSSL, yaSSL, and wolfCrypt are available for $5,000 USD per end product
|
||||
or SKU. Licenses are generally issued for one product and include unlimited
|
||||
royalty-free distribution. Custom licensing terms are also available.
|
||||
|
||||
Email: licensing@wolfssl.com
|
||||
|
||||
Phone: +1 425 245-8247
|
||||
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.
|
||||
|
|
|
|||
92
README.rst
92
README.rst
|
|
@ -3,46 +3,96 @@
|
|||
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.
|
||||
|
||||
|
||||
**REQUIRES** `wolfSSL <https://github.com/wolfSSL/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
|
||||
$ ./autogen.sh
|
||||
$ ./configure
|
||||
$ make
|
||||
$ sudo make install
|
||||
|
||||
|
||||
1. Clone the repository::
|
||||
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
|
||||
|
||||
|
||||
$ git clone git@github.com:wolfssl/wolfcrypt-py.git
|
||||
wolfcrypt source installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To install ``wolfcrypt`` from sources:
|
||||
|
||||
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...
|
||||
|
||||
or if you need admin privileges to use the install command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo python setup.py install
|
||||
|
||||
|
||||
2. Make sure that ``cffi``, ``py.test``, and ``tox`` are installed::
|
||||
Testing
|
||||
-------
|
||||
|
||||
Test ``wolfcrypt`` locally with ``tox``:
|
||||
|
||||
1. Make sure that the testing requirements are installed:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install -r requirements-testing.txt
|
||||
|
||||
|
||||
3. Run ``python setup.py install`` to build and install wolfcrypt::
|
||||
|
||||
|
||||
$ python setup.py install
|
||||
...
|
||||
Finished processing dependencies for wolfcrypt==0.1.0
|
||||
|
||||
|
||||
4. Test locally with ``tox``::
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,4 @@
|
|||
wolfCrypt Python Documentation
|
||||
==================================
|
||||
|
||||
**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.
|
||||
.. include:: ../README.rst
|
||||
|
||||
Summary
|
||||
-------
|
||||
|
|
@ -21,26 +12,4 @@ Summary
|
|||
mac
|
||||
random
|
||||
|
||||
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
|
||||
~~~~~~~~~~~
|
||||
|
||||
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.
|
||||
.. include:: ../LICENSING.rst
|
||||
|
|
|
|||
14
setup.py
14
setup.py
|
|
@ -23,15 +23,9 @@
|
|||
from __future__ import absolute_import
|
||||
import os
|
||||
import sys
|
||||
import wolfcrypt
|
||||
from wolfcrypt.__about__ import metadata
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
try:
|
||||
import about
|
||||
except ImportError:
|
||||
error = "about is not installed, refer to <{url}> for instructions."
|
||||
raise ImportError(error.format(url="https://pypi.io/project/about/"))
|
||||
|
||||
os.chdir(os.path.dirname(sys.argv[0]) or ".")
|
||||
|
||||
long_description = open("README.rst", "rt").read().replace(
|
||||
|
|
@ -40,7 +34,7 @@ long_description = open("README.rst", "rt").read().replace(
|
|||
)
|
||||
|
||||
info = dict(
|
||||
metadata = about.get_metadata(wolfcrypt),
|
||||
metadata = {k[2:-2]: metadata[k] for k in metadata},
|
||||
contents = {
|
||||
"long_description": long_description,
|
||||
"package_data": {"": ["*.txt"]},
|
||||
|
|
@ -48,8 +42,8 @@ info = dict(
|
|||
"cffi_modules": ["./wolfcrypt/build_ffi.py:ffi"],
|
||||
},
|
||||
requirements = {
|
||||
"setup_requires": ["cffi>=1.6.0", "about>=5.2"],
|
||||
"install_requires": ["cffi>=1.6.0", "about>=5.2"],
|
||||
"setup_requires": ["cffi>=1.6.0"],
|
||||
"install_requires": ["cffi>=1.6.0"],
|
||||
},
|
||||
scripts = {},
|
||||
plugins = {},
|
||||
|
|
|
|||
|
|
@ -19,16 +19,25 @@
|
|||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
||||
|
||||
metadata = dict(
|
||||
__name__ = "wolfcrypt",
|
||||
__version__ = "0.1.5",
|
||||
__license__ = """GPLv2 or Commercial License""",
|
||||
__author__ = "wolfSSL Inc. <info@wolfssl.com>",
|
||||
__url__ = "https://wolfssl.github.io/wolfcrypt-py",
|
||||
__summary__ = "A Python library that encapsulates wolfSSL's wolfCrypt API.",
|
||||
__keywords__ = """
|
||||
OS independent, Python / 2.7, Python / 3.5, software development,
|
||||
security, cryptography, Proprietary, GPLv2
|
||||
""",
|
||||
__name__ = "wolfcrypt",
|
||||
__version__ = "0.1.6",
|
||||
__license__ = "GPLv2 or Commercial License",
|
||||
__author__ = "wolfSSL Inc.",
|
||||
__author_email__ = "info@wolfssl.com",
|
||||
__url__ = "https://wolfssl.github.io/wolfcrypt-py",
|
||||
__description__ = \
|
||||
u"A Python library that encapsulates wolfSSL's wolfCrypt API.",
|
||||
__keywords__ = "security, cryptography",
|
||||
__classifiers__ = [
|
||||
u"License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
|
||||
u"License :: Other/Proprietary License",
|
||||
u"Operating System :: OS Independent",
|
||||
u"Programming Language :: Python :: 2.7",
|
||||
u"Programming Language :: Python :: 3.5",
|
||||
u"Topic :: Security",
|
||||
u"Topic :: Security :: Cryptography",
|
||||
u"Topic :: Software Development"
|
||||
]
|
||||
)
|
||||
|
||||
globals().update(metadata)
|
||||
|
|
|
|||
Loading…
Reference in New Issue