first commit

Author: rhysrevans3

.DS_Store

@@ -0,0 +1,26 @@
+Copyright 2021 United Kingdom Research and Innovation
+
+Authors: Rhys Evans
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

LICENSE

@@ -0,0 +1,50 @@
+# encoding: utf-8
+"""
+
+"""
+__author__ = "Rhys Evans"
+__date__ = "07 Jun 2021"
+__copyright__ = "Copyright 2018 United Kingdom Research and Innovation"
+__license__ = "BSD - see LICENSE file in top-level package directory"
+__contact__ = "[email protected]"
+
+from abc import ABC, abstractmethod
+
+
+class ExtractionMethod(ABC):
+    """
+    Class to act as a base for all extracion methods. Defines the basic method signature
+    and ensure compliance by all subclasses.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Set the kwargs to generate instance attributes of the same name
+
+        :param kwargs:
+        """
+        # Set default processor settings
+        if "default_conf" in kwargs:
+            self._set_attrs(kwargs["default_conf"])
+        # Override with specific processor settings
+        self._set_attrs(kwargs)
+
+    def _set_attrs(self, conf: dict) -> None:
+        """
+        Set instance attributes
+
+        :param conf:
+        """
+        for key, value in conf.items():
+            setattr(self, key, value)
+
+    @abstractmethod
+    def run(self, body: dict, **kwargs) -> dict:
+        """
+        Run the extration method
+
+        :param body:
+        :param kwargs:
+
+        :return body:
+        """

extraction_methods/.DS_Store

@@ -0,0 +1,8 @@
+# encoding: utf-8
+"""
+"""
+__author__ = "Rhys Evans"
+__date__ = "27 May 2021"
+__copyright__ = "Copyright 2018 United Kingdom Research and Innovation"
+__license__ = "BSD - see LICENSE file in top-level package directory"
+__contact__ = "[email protected]"