working refactor so far

Author: rootware

README.md

@@ -71,28 +71,6 @@ Redact using custom regex pattern
 pyredactkit -f file -c custom.json
 ```
 
-<!-- Install nltk data for redacting names
-
-```bash
-python -c "import nltk
-import ssl
-
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    pass
-else:
-    ssl._create_default_https_context =_create_unverified_https_context
-
-nltk.download('popular')"
-```
-
-Redact names from a text file
-
-```bash
-pyredactkit test.txt -t name
-``` -->
-
 ### Use from github source
 
 Clone the repo

images/classes.png

@@ -0,0 +1,29 @@
+""" Common jobs class implementation """
+import mimetypes
+import os
+import sys
+import re
+import math
+import json
+import uuid
+
+
+class CommonJobs:
+    """Common Jobs class
+    Class containing all methods to support redaction
+    of sensitive data
+
+    Static variables:
+        block (unicode string): To redact sensitive data
+    """
+
+    def __init__(self) -> None:
+        """
+        Class Initialization
+        Args:
+            None
+
+        Returns:
+            None
+        """
+        return None

pyredactkit/common_jobs.py

@@ -1,4 +1,4 @@
-""" Main redactor class implementation """
+""" Core redactor engine class implementation """
 
 import mimetypes
 import os
@@ -10,13 +10,13 @@
 
 from pyredactkit.identifiers import Identifier
 id_object = Identifier()
-""" Main redactor library """
+""" Coreredactor library """
 
 
-class Redactor:
-    """Redactor class
+class CoreRedactorEngine:
+    """CoreRedactorEngine class
     Class containing all methods to support redaction
-    of sensitive data
+    of core sensitive data type
 
     Static variables:
         block (unicode string): To redact sensitive data
@@ -34,52 +34,7 @@ def __init__(self) -> None:
         Returns:
             None
         """
-        self.__allowed_files__ = [
-            "text/plain",
-            "text/x-python",
-            "application/json",
-            "application/javascript",
-            "text/html",
-            "text/csv",
-            "text/tab-separated-values",
-            "text/css",
-            "text/cache-manifest",
-            "text/calendar",
-        ]
-
-    @staticmethod
-    def check_file_type(file):
-        """Checks for the supplied file type
-        Args:
-            file (str): Filename of file to check
-        Returns:
-            mime (str): Mime type
-        """
-        if not os.path.isfile(file):
-            return (None, None)
-        return mimetypes.guess_type(file)[0]
-
-    def get_allowed_files(self):
-        """Gets a list of allowed files
-        Args:
-            None
-        Returns:
-            allowed_file (list): List of allowed files
-        """
-        return self.__allowed_files__
-
-    def allowed_file(self, file):
-        """Checks if supplied file is allowed
-        Checks the supplied file to see if it is in the allowed_files list
-        Args:
-            file (str): File to check
-        Returns:
-            False: File not found / File type is not allowed
-            True: File is allowed
-        """
-        if not os.path.isfile(file):
-            return False
-        return mimetypes.guess_type(file)[0] in self.get_allowed_files()
+        return None
 
     def read_custom_patterns(self, custom_file) -> list:
         '''Load Rules

pyredactkit/redact.py pyredactkit/core_redactor.pypyredactkit/redact.py renamed to pyredactkit/core_redactor.py

@@ -5,14 +5,14 @@
 
 import argparse
 
-from pyredactkit.redact import Redactor
+from pyredactkit.core_redactor import CoreRedactorEngine
 from pyredactkit.unredact import Unredactor
 import os
 import glob
 import sys
 
 # Creating instances of redact and unredact classes
-redact_obj = Redactor()
+redact_obj = CoreRedactorEngine()
 unredact_obj = Unredactor()
 
 

pyredactkit/pyredactkit.py

@@ -1,5 +1,5 @@
 import pytest
-from pyredactkit.redact import Redactor
+from pyredactkit.core_redactor import Redactor
 
 data = """John, please get that article on www.linkedin.com to me by 5:00PM on Jan 9th 2012. 4:00 would be ideal, actually. If you have any questions, You can reach me at(519)-236-2723 or get in touch with my associate at [email protected]
 this is my IP: 102.23.5.1