New encoding utilities

README.md

@@ -12,6 +12,7 @@ The HDX Python Utilities Library provides a range of helpful utilities:
 1.  [Easy logging setup](#configuring-logging)
 1.  [Path utilities](#path-utilities)
 1. [Text processing](#text-processing)
+1. [Encoding utilities](#encoding-utilities)
 1. [Py3-like raise from for Py2](#raise-from)
 1. [Check valid UUID](#valid-uuid)
 1. [Easy building and packaging](#easy-building-and-packaging)
@@ -378,6 +379,15 @@ Examples:
     result = get_matching_text([a, b, c], match_min_size=10)
     assert result == ' brown fox  over the  It was so fast!'
 
+### Encoding utilities
+
+Examples:
+
+    ## Base 64 encode and decode string
+    a = 'The quick brown fox jumped over the lazy dog. It was so fast!'
+    b = str_to_base64(a)
+    c = base64_to_str(b)
+
 ### Raise from
 
 Examples:

requirements.txt

@@ -1,13 +1,13 @@
 basicauth==0.4.1
 beautifulsoup4==4.8.1
 colorlog==4.0.2
-email_validator==1.0.4
+email_validator==1.0.5
 html5lib==1.0.1
-psycopg2-binary==2.8.3
+psycopg2-binary==2.8.4
 pyaml==19.4.1
 ratelimit==2.2.1
 six==1.12.0
 sshtunnel==0.1.5
-tabulator==1.27.0
+tabulator==1.28.0
 typing==3.7.4.1
 yamlloader==0.5.5

setup.py

@@ -18,7 +18,7 @@
                 'ratelimit',
                 'six>=1.12.0',
                 'sshtunnel',
-                'tabulator>=1.27.0',
+                'tabulator>=1.28.0',
                 'typing',
                 'yamlloader'
                 ]

src/hdx/utilities/encoding.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+"""Encoding utilities"""
+
+import base64
+
+
+def str_to_base64(string):
+    # type: (str) -> str
+    """
+    Base 64 encode string
+
+    Args:
+        string (str): String to encode
+
+    Returns:
+        str: Base 64 encoded string
+
+    """
+    return base64.urlsafe_b64encode(string.encode('utf-8')).decode('utf-8')
+
+
+def base64_to_str(bstring):
+    # type: (str) -> str
+    """
+    Base 64 decode string
+
+    Args:
+        bstring (str): Base 64 encoded string to encode
+
+    Returns:
+        str: Decoded string
+
+    """
+    return base64.urlsafe_b64decode(bstring.encode('utf-8')).decode('utf-8')

src/hdx/utilities/text.py

@@ -8,7 +8,7 @@
 
 def multiple_replace(string, replacements):
     # type: (str, Dict[str,str]) -> str
-    """Simultaneously replace multiple strigns in a string
+    """Simultaneously replace multiple strings in a string
 
     Args:
         string (str): Input string

src/hdx/utilities/version.txt

@@ -1 +1 @@
-1.8.5
+1.8.6

tests/hdx/utilities/test_encoding.py

@@ -0,0 +1,11 @@
+# -*- coding: UTF-8 -*-
+"""Encoding Utility Tests"""
+from hdx.utilities.encoding import str_to_base64, base64_to_str
+
+
+class TestEncoding:
+    def test_base64(self):
+        string = 'hello'
+        result = str_to_base64(string)
+        assert result == 'aGVsbG8='
+        assert base64_to_str(result) == string