v2.0.0 MAJOR - Added crypto.KeyManager plus more

There have been many, many changes since version 1.0, so I've decided it's about time that we finally bump our major version to version 2.0.0

While this release isn't really a *breaking change* from 1.5.0, there have been so many breaking changes introduced in the 1.x.x series, as well
as major new features such as a cache abstraction layer and a cryptography module, it's worth having a clean semver slate with 2.0.0

**Docs**

  - Added documentation for `byteify` and `stringify`
  - Added documentation for the `crypto` module
  - Added documentation for the `setuppy` module
  - Updated the custom sphinx CSS to allow for a sensible 5th nesting level in the navigation
  - Adjusted the sphinx templates for `autosummary/class.rst` and `autosummary/module.rst`
    - Insert toctree directive automatically into generated files, so sub-components automatically have their RST stubs for navigation generated,
      instead of having to manually modify the generate files afterwards.
        - `:toctree:` is automatically added for module functions+classes
        - `:toctree:` is automatically added for class methods+attributes
    - The headings "Methods" and "Attributes" are automatically added for classes, for display in the navigation bar.
  - Added `sphinx_rtd_theme` as an import and in the extension list in `conf.py` (the README says to do this, so maybe it will prevent issues in the future?)

**Packaging**

  - Added `extras_require` to setup.py, allowing "extras" to be specified when installing privex-helpers, instead of
    having to specify optional dependencies directly in your requirements.txt
  - Excluded the `tests` module from the package

**Unit Tests**

  - Created `TestKeyManager` class inside of `tests/test_crypto.py` which tests the new asymmetric key system
     - Tests generation of RSA, ECDSA and Ed25519 keys by checking the public/private key length, as well as looking for strings in their output format
     - Tests loading of RSA, ECDSA, and Ed25519 keys
     - Tests loading invalid keys correctly raises an exception (otherwise how do we know that the previous loading attempts weren't just being ignored?)
     - Tests signing and verifying messages for RSA, ECDSA and Ed25519 keys
     - Tests encryption and decryption for RSA keys (other algorithms don't support encryption/decryption)

**Code**

  - `crypto` module is now a folder python module
     - Moved EncryptHelper into crypto/EncryptHelper.py
     - Created crypto/base.py with helper functions such as `is_base64` and `auto_b64decode`
     - Created crypto/KeyManager.py
        - Generates Asymmetric keys in RSA, ECDSA and Ed25519 format
        - Serialize public/private keys into various formats, default: PEM+PKCS8 for private, OpenSSH for public
        - Load public/private keys in most formats, with auto detection
        - Ability to load a key from a file
        - Automatically interpolate public key when loading a private key
        - Ability to output generated keys to private and public file
        - Signing messages with RSA, ECDSA, and Ed25519
        - Verifying messages with RSA, ECDSA, and Ed25519
        - Encrypting messages/data with RSA
        - Decrypting messages/data with RSA
        - Lots of PyDoc blocks, clearly documenting how everything works
  - New `setuppy` module with various packaging related helpers, such as parsing requirements files and handling importing other requirements files
  - Added `InvalidFormat` exception, used by the crypto module
  - `common` module
    - New `byteify` function - convert a value into bytes if it isn't already bytes
    - New `stringify` function - decode bytes into a string, if it isn't already a string

Author: Someguy123

.travis.yml

@@ -7,6 +7,7 @@ env:
 python:
   - "3.6"
   - "3.7"
+  - "3.8"
   - "3.7-dev"
   - "3.8-dev"
   - "nightly"

README.md

@@ -32,6 +32,19 @@ packaged, and so we've amalgamated them into this PyPi package, `privex-helpers`
     +===================================================+
 ```
 
+# Table of Contents (Github README)
+
+1. [Install](#Install)
+    1.1 [Via PyPi (pip)](#download-and-install-from-pypi)
+    1.2 [Manually via Git](#alternative-manual-install-from-git)
+2. [Documentation](#documentation)
+3. [License](#License)
+4. [Example Uses](#example-uses)
+5. [Minimal Dependencies / Using package extras](#minimal-dependencies)
+6. [Unit Tests](#unit-tests)
+7. [Contributing](#contributing)
+
+
 # Install
 
 ### Download and install from PyPi 
@@ -177,7 +190,7 @@ ip_is_v6('2a07:e00::1') # True
 
 # Minimal dependencies
 
-Most of our helper code is independant, and does not result in any extra dependencies being installed. 
+Most of our helper code is independent, and does not result in any extra dependencies being installed. 
 
 Some of our helpers are dependant on external libraries or frameworks, such as Django or Flask. To avoid
 large Python packages such as Django being installed needlessly, we programatically enable/disable some
@@ -187,17 +200,68 @@ This package only requires (and automatically installs if needed) a single depen
 [privex-loghelper](https://github.com/Privex/python-loghelper) package, which itself is lightweight
 and dependency free.
 
+As of version 1.6.0 - Privex Helpers now supports **Setuptools Extras**, allowing you
+to specify extra dependencies related to privex-helpers in your requirements.txt, or when running
+**pip3 install**.
+
+```
+# full: Install all extra dependencies if they aren't already installed
+#   NOTE: Excludes the `django` extras, because Django + sub-deps weighs ~30-50mb - plus you'd normally only
+#   be using the `django` module in a Django project, where you'd have the deps installed anyway...
+#
+# crypto:   Install dependencies related to the `crypto` module
+# cache:    Install dependencies related to the `cache` module
+# django:   Install dependencies related to the `django` module
+# net:      Install dependencies related to the `net` module
 
-Optional requirements (just `pip3 install` them depending on the helpers you require):
+# Example: Install privex-helpers AND all optional dependencies (excluding django), for full functionality
+pip3 install 'privex-helpers[full]'
+
+# Example: Install privex-helpers with only the crypto and cache module dependencies
+pip3 install 'privex-helpers[cache,crypto]'
+
+# Example: Install just privex-helpers and REQUIRED dependencies (i.e. critical to basic functionality)
+pip3 install privex-helpers
+```
+
+
+Alternatively, just `pip3 install` extra packages depending on the helpers you require:
 
 ```
 # For all Django-specific helpers in privex.helpers.django
 Django
 # For certain DNS dependant helpers in privex.helpers.net
 dnspython>=1.16.0
-# For helpers such as the r_cache decorator which is dependent on Redis
+# For using Redis with the privex.helpers.cache module
 redis>=3.3.8
+# For using the privex.helpers.crypto module
+cryptography>=2.8
+```
+
+# Unit Tests
+
+As of late October 2019, we have over 70 individual unit tests in the `tests/` folder, which are split into several
+`test_xxxx` files, with each file holding tests for a specific module or smaller area of code. This library 
+consistently maintains on average 70-80% test coverage, helping to show this package is highly tested to ensure
+reliable and robust code.
+
+We use [Travis CI](https://travis-ci.com/Privex/python-helpers) for continuous integration, which runs the test
+suite every time a new commit, tag, or branch is pushed to this Github repo.
+
+We also use [CodeCov](https://codecov.io/gh/Privex/python-helpers) which integrates with our Travis CI setup, and
+provides test coverage statistics, so ourselves and contributors can visually see how much of the code is covered
+by our unit tests 
+
+TL;Dr; Run the tests:
+
 ```
+pip3 install -r docs/requirements.txt
+pytest -v
+```
+
+For more information about using the unit tests, see the 
+[How to use the unit tests](https://python-helpers.readthedocs.io/en/latest/helpers/tests.html) section of 
+the documentation. 
 
 # Contributing
 

docs/source/_static/css/custom.css

@@ -2,4 +2,18 @@
 
 .wy-nav-content {
     max-width: 1200px !important;
-}
+}
+
+li.toctree-l4 li.toctree-l5 > a {
+    display: none
+}
+
+li.toctree-l5.current > a {
+    display: block
+}
+
+.wy-menu-vertical li.toctree-l4.current li.toctree-l5 > a {
+    display: block;
+    background: #bdbdbd;
+    padding: .4045em 6em;
+}

docs/source/_templates/autosummary/class.rst

@@ -4,26 +4,34 @@
 
 .. autoclass:: {{ objname }}
 
-   {% block methods %}
-   .. automethod:: __init__
-
-   {% if methods %}
-   .. rubric:: Methods
-
-   .. autosummary::
-   {% for item in methods %}
-      ~{{ name }}.{{ item }}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
-
-   {% block attributes %}
-   {% if attributes %}
-   .. rubric:: Attributes
-
-   .. autosummary::
-   {% for item in attributes %}
-      ~{{ name }}.{{ item }}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
+{% block methods %}
+.. automethod:: __init__
+
+{% if methods %}
+Methods
+^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :toctree: {{ name | lower }}
+{% for item in methods %}
+   ~{{ name }}.{{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
+
+{% block attributes %}
+{% if attributes %}
+Attributes
+^^^^^^^^^^
+
+.. rubric:: Attributes
+
+.. autosummary::
+   :toctree: {{ name | lower }}
+{% for item in attributes %}
+   ~{{ name }}.{{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/source/_templates/autosummary/module.rst

@@ -7,6 +7,7 @@
    .. rubric:: Functions
 
    .. autosummary::
+      :toctree: {{ name }}
    {% for item in functions %}
       {{ item }}
    {%- endfor %}
@@ -18,6 +19,7 @@
    .. rubric:: Classes
 
    .. autosummary::
+      :toctree: {{ name }}
    {% for item in classes %}
       {{ item }}
    {%- endfor %}

docs/source/conf.py

@@ -16,6 +16,7 @@
 
 import os
 import sys
+import sphinx_rtd_theme
 
 # Add base directory of the project to the path
 sys.path.insert(0, os.path.abspath('../..'))
@@ -38,6 +39,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
+    'sphinx_rtd_theme',
 ]
 
 autosummary_generate = True

docs/source/helpers/common/privex.helpers.common.byteify.rst

@@ -0,0 +1,6 @@
+byteify
+=======
+
+.. currentmodule:: privex.helpers.common
+
+.. autofunction:: byteify

docs/source/helpers/common/privex.helpers.common.stringify.rst

@@ -0,0 +1,6 @@
+stringify
+=========
+
+.. currentmodule:: privex.helpers.common
+
+.. autofunction:: stringify

docs/source/helpers/crypto/base/privex.helpers.crypto.base.auto_b64decode.rst

@@ -0,0 +1,6 @@
+auto\_b64decode
+===============
+
+.. currentmodule:: privex.helpers.crypto.base
+
+.. autofunction:: auto_b64decode

docs/source/helpers/crypto/base/privex.helpers.crypto.base.is_base64.rst

@@ -0,0 +1,6 @@
+is\_base64
+==========
+
+.. currentmodule:: privex.helpers.crypto.base
+
+.. autofunction:: is_base64