v1.5.0 - Added crypto module + docs improvements

Someguy123 · Someguy123 · commit 7473840b5579 · 2019-10-23T21:43:13.000+01:00
- Added `crypto` module with new `EncryptHelper` class, designed to make using encryption
   via `cryptography.fernet` painless as possible.
 - Added docs for `crypto` module
 - Set up InterSphinx, allowing for cross referencing several different package docs
 - Added new exceptions `EncryptionError` and `EncryptKeyMissing` - related to `crypto` module
 - Added several unit tests for the `crypto` module in `test_crypto.py`
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -10,6 +10,7 @@ Django>=2
 dnspython>=1.16.0
 redis>=3.3.8
 privex-loghelper>=1.0.4
+cryptography>=2.6
 
 # Unit testing
 pytest
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -145,7 +145,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'PrivexHelpers', 'CryptoToken Converter Documentation',
+    (master_doc, 'PrivexHelpers', 'Privex Python Helpers Documentation',
      author, 'PrivexHelpers', 'One line description of project.',
      'Miscellaneous'),
 ]
@@ -174,57 +174,9 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
-
-
-
-"""
-Taken from https://stackoverflow.com/a/30783465/2648583
-"""
-# from sphinx.ext.autosummary import Autosummary
-# from sphinx.ext.autosummary import get_documenter
-# from docutils.parsers.rst import directives
-# from sphinx.util.inspect import safe_getattr
-# import re
-
-# class AutoAutoSummary(Autosummary):
-
-#     option_spec = {
-#         'methods': directives.unchanged,
-#         'attributes': directives.unchanged
-#     }
-
-#     required_arguments = 1
-
-#     @staticmethod
-#     def get_members(obj, typ, include_public=None):
-#         if not include_public:
-#             include_public = []
-#         items = []
-#         for name in dir(obj):
-#             try:
-#                 documenter = get_documenter(safe_getattr(obj, name), obj)
-#             except AttributeError:
-#                 continue
-#             if documenter.objtype == typ:
-#                 items.append(name)
-#         public = [x for x in items if x in include_public or not x.startswith('_')]
-#         return public, items
-
-#     def run(self):
-#         clazz = str(self.arguments[0])
-#         try:
-#             (module_name, class_name) = clazz.rsplit('.', 1)
-#             m = __import__(module_name, globals(), locals(), [class_name])
-#             c = getattr(m, class_name)
-#             if 'methods' in self.options:
-#                 _, methods = self.get_members(c, 'method', ['__init__'])
-
-#                 self.content = ["~%s.%s" % (clazz, method) for method in methods if not method.startswith('_')]
-#             if 'attributes' in self.options:
-#                 _, attribs = self.get_members(c, 'attribute')
-#                 self.content = ["~%s.%s" % (clazz, attrib) for attrib in attribs if not attrib.startswith('_')]
-#         finally:
-#             return super(AutoAutoSummary, self).run()
-# def setup(app):
-#     app.add_directive('autoautosummary', AutoAutoSummary)
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3.6', None),
+    'cryptography': ('https://cryptography.io/en/latest/', None),
+    'django': ('http://django.readthedocs.org/en/latest/', None),
+}
+
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.__init__.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.__init__.rst
@@ -0,0 +1,6 @@
+\_\_init\_\_
+============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.__init__
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.decrypt_str.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.decrypt_str.rst
@@ -0,0 +1,6 @@
+decrypt\_str
+============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.decrypt_str
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.encrypt_str.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.encrypt_str.rst
@@ -0,0 +1,6 @@
+encrypt\_str
+============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.encrypt_str
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.from_file.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.from_file.rst
@@ -0,0 +1,6 @@
+from\_file
+==========
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.from_file
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.from_password.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.from_password.rst
@@ -0,0 +1,6 @@
+from\_password
+==============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.from_password
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.generate_key.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.generate_key.rst
@@ -0,0 +1,6 @@
+generate\_key
+=============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.generate_key
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.get_fernet.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.get_fernet.rst
@@ -0,0 +1,6 @@
+get\_fernet
+===========
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.get_fernet
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.is_encrypted.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.is_encrypted.rst
@@ -0,0 +1,6 @@
+is\_encrypted
+=============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.is_encrypted
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.password_key.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.password_key.rst
@@ -0,0 +1,6 @@
+password\_key
+=============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. automethod:: EncryptHelper.password_key
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.rst b/docs/source/helpers/crypto/privex.helpers.crypto.EncryptHelper.rst
@@ -0,0 +1,31 @@
+EncryptHelper
+=============
+
+.. currentmodule:: privex.helpers.crypto
+
+.. autoclass:: EncryptHelper
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree:
+   
+      ~EncryptHelper.__init__
+      ~EncryptHelper.decrypt_str
+      ~EncryptHelper.encrypt_str
+      ~EncryptHelper.from_file
+      ~EncryptHelper.from_password
+      ~EncryptHelper.generate_key
+      ~EncryptHelper.get_fernet
+      ~EncryptHelper.is_encrypted
+      ~EncryptHelper.password_key
+   
+   
+
+   
+   
+   
diff --git a/docs/source/helpers/crypto/privex.helpers.crypto.isBase64.rst b/docs/source/helpers/crypto/privex.helpers.crypto.isBase64.rst
@@ -0,0 +1,6 @@
+isBase64
+========
+
+.. currentmodule:: privex.helpers.crypto
+
+.. autofunction:: isBase64
diff --git a/docs/source/helpers/index.rst b/docs/source/helpers/index.rst
@@ -5,6 +5,7 @@
     privex.helpers.asyncx
     privex.helpers.cache
     privex.helpers.common
+    privex.helpers.crypto
     privex.helpers.decorators
     privex.helpers.django
     privex.helpers.exceptions
diff --git a/docs/source/helpers/privex.helpers.crypto.rst b/docs/source/helpers/privex.helpers.crypto.rst
@@ -0,0 +1,30 @@
+privex.helpers.crypto
+=====================
+
+.. automodule:: privex.helpers.crypto
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: crypto
+
+      isBase64
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: crypto
+   
+      EncryptHelper
+   
+   
+
+   
+   
+   
diff --git a/docs/source/helpers/tests.rst b/docs/source/helpers/tests.rst
@@ -12,6 +12,7 @@ Unit Test List / Overview
     tests.base
     tests.test_bool
     tests.test_cache
+    tests.test_crypto
     tests.test_general
     tests.test_parse
     tests.test_rdns
diff --git a/docs/source/helpers/tests/tests.test_crypto.rst b/docs/source/helpers/tests/tests.test_crypto.rst
@@ -0,0 +1,22 @@
+tests.test\_crypto
+==================
+
+.. automodule:: tests.test_crypto
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      TestEncryptHelper
+   
+   
+
+   
+   
+   
diff --git a/privex/helpers/__init__.py b/privex/helpers/__init__.py
@@ -68,6 +68,11 @@
 except ImportError:
     log.debug('privex.helpers __init__ failed to import "asyncx", not loading async helpers')
     pass
+try:
+    from privex.helpers.crypto import *
+except ImportError:
+    log.debug('privex.helpers __init__ failed to import "crypto", not loading cryptography helpers')
+    pass
 
 
 def _setup_logging(level=logging.WARNING):
@@ -83,7 +88,7 @@ def _setup_logging(level=logging.WARNING):
 log = _setup_logging()
 name = 'helpers'
 
-VERSION = '1.4.1'
+VERSION = '1.5.0'
 
 
 
diff --git a/privex/helpers/crypto.py b/privex/helpers/crypto.py
diff --git a/privex/helpers/exceptions.py b/privex/helpers/exceptions.py
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_crypto.py b/tests/test_crypto.py
