Added initial skeleton

.gitignore

@@ -0,0 +1,19 @@
+# MacOS
+.DS_Store
+
+# Terraform Specific
+**/.terraform/*
+ignore.*.tfvars
+
+# IDE specific
+.idea/
+.vscode/
+
+# Project Specific
+DEVNOTES
+tmp/
+
+# Python Specific
+.venv/
+__pycache__/
+*.pyc

.python-version

@@ -0,0 +1 @@
+3.11.9

configs/devhasaniqbal.json

@@ -0,0 +1,3 @@
+{
+    "hello": "world"
+}

scripts/cli.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Script for running openfactcheck
+#
+# Examples
+# --------
+# $ ./run.sh
+#
+
+source "${BASH_SOURCE%/*}/common.sh"
+
+# Executing Python script
+export PYTHONPATH="$PYTHONPATH:src/"
+python src/openfactcheck/core/cli.py "$@"

scripts/common.sh

@@ -0,0 +1,62 @@
+#!/bin/bash
+
+################################################################################
+# Shell dependencies                                                           #
+################################################################################
+# https://stackoverflow.com/questions/592620/how-can-i-check-if-a-program-exists-from-a-bash-script
+
+if ! [ -x "$(command -v git)" ]; then
+  echo 'Error: git is not installed.' >&2
+  exit 1
+fi
+
+################################################################################
+# Common Functions                                                             #
+################################################################################
+
+# Echo's the text to the screen with the designated color
+c_echo () {
+    local color=$1
+    local txt=$2
+
+    echo -e "${color}${txt}${NC}"
+}
+
+# Enforces you are running from project root
+force_project_root () {
+    DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+    PARENT_DIR=$(dirname $DIR)
+
+    if [ "$(pwd)" != $PARENT_DIR ]
+    then
+        c_echo $RED "You must be in $PARENT_DIR to run"
+        exit 1
+    fi
+}
+
+################################################################################
+# Color Constants                                                              #
+################################################################################
+GREEN='\033[0;32m'
+YELLOW='\033[0;33m'
+RED='\033[0;31m'
+NC='\033[0m'
+
+################################################################################
+# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ENFORCE !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!#
+################################################################################
+force_project_root
+
+################################################################################
+# Application Versioning Information                                           #
+################################################################################
+APP_NAME=openfactcheck
+APP_VERSION=$(git describe --tags --dirty) || exit 1
+COMMIT=$(git rev-parse HEAD)
+
+################################################################################
+# Common Paths                                                                 #
+################################################################################
+BUILDBIN_PATH=$(pwd)/tmp/build/bin
+DEPLOYMENTS_PATH=$(pwd)/deployments
+TERRAFORM_PATH=$(pwd)/deployments/terraform

src/openfactcheck/__init__.py

@@ -0,0 +1,2 @@
+from .lib.config import OpenFactCheckConfig
+from .core.base import OpenFactCheck

src/openfactcheck/core/__init__.py

@@ -0,0 +1 @@
+from .base import OpenFactCheck

src/openfactcheck/core/base.py

@@ -0,0 +1,13 @@
+from openfactcheck.lib.logger import logger
+from openfactcheck.lib.config import OpenFactCheckConfig
+
+class OpenFactCheck:
+    def __init__(self, config: OpenFactCheckConfig):
+        self.logger = logger
+        self.config = config
+
+        self.logger.info("OpenFactCheck initialized")
+
+if __name__ == "__main__":
+    config = OpenFactCheckConfig()
+    ofc = OpenFactCheck(config)

src/openfactcheck/core/cli.py

@@ -0,0 +1,24 @@
+import argparse
+
+from openfactcheck.core.base import OpenFactCheck
+from openfactcheck.lib.config import OpenFactCheckConfig
+
+def parse_args():
+    parser = argparse.ArgumentParser(description='Initialize OpenFactCheck with custom configuration.')
+    
+    # Add arguments here, example:
+    parser.add_argument("--config-path", 
+                        type=str, 
+                        help="Config File Path",
+                        default="config.json")
+    
+    # Parse arguments from command line
+    args = parser.parse_args()
+    return args
+
+if __name__ == "__main__":
+    args = parse_args()
+
+    ofc = OpenFactCheck(OpenFactCheckConfig(args.config_path))
+
+    

src/openfactcheck/core/fact_check_state.py

@@ -0,0 +1,49 @@
+import logging
+
+class FactCheckerState:
+    """
+    A class to manage the state of a fact checking system. It holds a question 
+    and its corresponding response, and provides methods to set and get these 
+    attributes dynamically.
+
+    Parameters
+    ----------
+    question : str
+        The question to be fact-checked.
+    response : str
+        The response to the question.
+    """
+    def __init__(self, question: str = None, response: str = None):
+        """
+        Initialize the FactCheckerState object.
+        """
+        self.question: str = question
+        self.response: str = response
+
+    def set(self, name, value):
+        """
+        Set an attribute of the state object.
+        """
+        if hasattr(self, name):
+            logging.warning(f"FactCheckerState.set: Modifying existing attribute {name}")
+        setattr(self, name, value)
+
+    def get(self, name):
+        """
+        Get an attribute of the state object.
+        """
+        if not hasattr(self, name):
+            raise ValueError(f"FactCheckerState.get: Attribute {name} does not exist")
+        return getattr(self, name, None)
+
+    def __str__(self):
+        """
+        Return a string representation of the state object.
+        """
+        return str(self.__dict__)
+
+    def to_dict(self):
+        """
+        Return a dictionary representation of the state object.
+        """
+        return self.__dict__

src/openfactcheck/core/standard_task_solver.py

@@ -0,0 +1,45 @@
+import logging
+from typing import Tuple
+
+from fact_check_state import FactCheckerState
+
+class StandardTaskSolver:
+    """
+    A class to represent a standard task solver. A standard task solver is a
+    class that implements a specific task in a fact-checking system. It
+    receives a FactCheckerState object as input and returns a new
+    FactCheckerState object as output.
+
+    Parameters
+    ----------
+    args : dict
+        A dictionary containing the arguments to be passed to the solver.
+    """
+
+    name: str = None
+    input_name: str = None
+    output_name: str = None
+    global_config: dict = dict()
+
+    def __init__(self, args: dict):
+        self.args = args
+        logging.debug(self.args)
+
+    def __call__(self, state: FactCheckerState, **kwargs) -> Tuple[
+        bool, FactCheckerState]:
+        raise NotImplementedError
+
+    @classmethod
+    def build_solver(cls, args):
+        raise NotImplementedError
+
+    @property
+    def input_name(self):
+        return self.__class__.input_name
+
+    @property
+    def output_name(self):
+        return self.__class__.output_name
+
+    def __str__(self):
+        return f'[name:"{self.__class__.name}", input: "{self.__class__.input_name}": output: "{self.__class__.output_name}"]'

src/openfactcheck/lib/__init__.py

@@ -0,0 +1,2 @@
+from .config import OpenFactCheckConfig
+from .logger import logger

src/openfactcheck/lib/config.py

@@ -0,0 +1,30 @@
+import json
+from pathlib import Path
+from typing import Union
+
+from .logger import logger
+
+class OpenFactCheckConfig:
+    def __init__(self, filename: Union[str, Path] = "config.json"):
+        # Setup Logger
+        self.logger = logger
+
+        self.filename = filename
+
+        try:
+            # Loading Config File
+            with open(self.filename, encoding="utf-8") as file:
+                self.filename = json.load(file)
+
+        except FileNotFoundError:
+            self.logger.error(f"Config file not found: {self.filename}")
+            raise FileNotFoundError(f"Config file not found: {self.filename}")
+        
+        except json.JSONDecodeError:
+            self.logger.error(f"Invalid JSON in config file: {self.filename}")
+            raise ValueError(f"Invalid JSON in config file: {self.filename}")
+        
+        except Exception as e:
+            self.logger.error(f"Error loading config file: {e}")
+            raise Exception(f"Error loading config file: {e}")
+        

src/openfactcheck/lib/logger.py

@@ -0,0 +1,38 @@
+import logging
+
+def get_logger():
+    """
+    This function returns a logger object that can be used to log messages 
+    to the console and a file.
+    """
+
+    # Console Logger
+    console_formatter = logging.Formatter('%(levelname)s -- %(message)s')
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.DEBUG)
+    console_handler.setFormatter(console_formatter)
+
+    # File Logger
+    # file_formatter = logging.Formatter(
+    # '%(asctime)s — %(levelname)s — %(funcName)s:%(lineno)d — %(message)s', datefmt='%m-%d-%Y %H:%M:%S')
+    # file_handler = logging.FileHandler("lambda.log")
+    # file_handler.setLevel(logging.DEBUG)
+    # file_handler.setFormatter(file_formatter)
+
+    # Getting the root logger
+    newlogger = logging.getLogger(__name__)
+
+    # Adding the handlers
+    # logger.addHandler(file_handler)
+    newlogger.addHandler(console_handler)
+
+    # Setting the level
+    newlogger.setLevel(logging.DEBUG)
+
+    # Preventing the loggers from propagating to the root logger
+    newlogger.propagate = False
+
+    return newlogger
+
+
+logger = get_logger()