Merge pull request #42 from coding-kitties/develop

Develop

Author: coding-kitties

LICENSE

@@ -3,7 +3,7 @@ Business Source License 1.1
 Parameters
 
 Licensor:             coding kitties.
-Licensed Work:        Investing Algorithm Framework
+Licensed Work:        Investing Algorithm Framework.
                       The Licensed Work is (c) 2020 coding kitties.
 Additional Use Grant: You may make use of the Licensed Work, provided that you do
                       not use the Licensed Work for an Algorithm
@@ -14,7 +14,23 @@ Additional Use Grant: You may make use of the Licensed Work, provided that you d
                       contractors) to sell and host applications created with the Licensed
                       Work.
 
-Change Date:          2023-06-20
+                      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 OWNER 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.
+
+Change Date:          2023-07-16
 
 Change License:       Apache License, Version 2.0
 

investing_algorithm_framework/__init__.py

@@ -3,4 +3,3 @@
 VERSION = (0, 1, 1, 'alpha', 0)
 
 __all__ = ['get_version']
-

investing_algorithm_framework/configuration/__init__.py

@@ -2,70 +2,18 @@
 import logging.config
 from typing import Any
 from importlib import import_module
-from enum import Enum
 
 from investing_algorithm_framework.core.exceptions \
     import ImproperlyConfigured, OperationalException
 from investing_algorithm_framework.configuration.config_constants \
-    import SETTINGS_MODULE_PATH_ENV_NAME, \
-    SETTINGS_STRATEGY_REGISTERED_APPS, SETTINGS_LOGGING_CONFIG, \
-    SETTINGS_DATA_PROVIDER_REGISTERED_APPS
+    import SETTINGS_MODULE_PATH_ENV_NAME,  SETTINGS_LOGGING_CONFIG
 
 
-class TimeUnit(Enum):
-    SECOND = 'SEC',
-    MINUTE = 'MIN',
-    HOUR = 'HR',
-    ALWAYS = 'ALWAYS'
-
-    # Static factory method to convert a string to time_unit
-    @staticmethod
-    def from_string(value: str):
-
-        if isinstance(value, str):
-
-            if value.lower() in ('sec', 'second', 'seconds'):
-                return TimeUnit.SECOND
-
-            elif value.lower() in ('min', 'minute', 'minutes'):
-                return TimeUnit.MINUTE
-
-            elif value.lower() in ('hr', 'hour', 'hours'):
-                return TimeUnit.HOUR
-
-            elif value.lower() in (
-                    'always', 'every', 'continuous', 'every_time'
-            ):
-                return TimeUnit.ALWAYS
-            else:
-                raise OperationalException(
-                    'Could not convert value {} to a time_unit'.format(value)
-                )
-
-        else:
-            raise OperationalException(
-                "Could not convert non string value to a time_unit"
-            )
-
-    def equals(self, other):
-
-        if isinstance(other, Enum):
-            return self.value == other.value
-        else:
-
-            try:
-                time_unit = TimeUnit.from_string(other)
-                return time_unit == self
-            except OperationalException:
-                pass
-
-            return other == self.value
-
-
-class BaseSettings:
+class ContextConfiguration:
     """
-    Base wrapper for settings module. It will load all the default settings
-    for a given settings module
+    Base wrapper for ContextConfiguration module. It will load all the
+    default settings for a given settings module and will allow for run time
+    specification
     """
 
     def __init__(self) -> None:
@@ -88,29 +36,20 @@ def configure(self, settings_module: str = None) -> None:
         # Load the settings module
         module = import_module(self.settings_module)
 
-        # Base components
-        tuple_settings = (
-            SETTINGS_STRATEGY_REGISTERED_APPS,
-            SETTINGS_DATA_PROVIDER_REGISTERED_APPS,
-        )
-
         # Set all the attributes of the settings wrapper
         for setting in dir(module):
 
             if setting.isupper():
                 setting_value = getattr(module, setting)
-
-                if setting in tuple_settings and \
-                        not isinstance(setting_value, (list, tuple)):
-                    raise ImproperlyConfigured(
-                        "The {} setting must be a list or a "
-                        "tuple.".format(setting))
-
                 setattr(self, setting, setting_value)
 
         self._configured = True
 
-        logging.config.dictConfig(self[SETTINGS_LOGGING_CONFIG])
+        try:
+            logging.config.dictConfig(self[SETTINGS_LOGGING_CONFIG])
+        except Exception:
+            # We ignore the error no logging configuration.
+            pass
 
     @property
     def settings_module(self) -> str:
@@ -130,14 +69,14 @@ def __getitem__(self, item) -> Any:
 
             if not hasattr(self, item):
                 raise OperationalException(
-                    "Setting object doesn't have the specific "
+                    "ContextConfig object doesn't have the specific "
                     "attribute {}".format(item)
                 )
 
             return self.__getattribute__(item)
         else:
             raise OperationalException(
-                "Settings attributes can only be referenced by string"
+                "ContextConfig attributes can only be referenced by string"
             )
 
     def get(self, key: str, default: Any = None) -> Any:
@@ -153,5 +92,12 @@ def get(self, key: str, default: Any = None) -> Any:
 
         return default
 
+    def set(self, key: str, value: Any) -> None:
+
+        if hasattr(self, key):
+            raise OperationalException(
+                "ContextConfig object already have the specific "
+                "attribute {} specified".format(key)
+            )
 
-settings = BaseSettings()
+        setattr(self, key, value)

investing_algorithm_framework/configuration/config_constants.py

@@ -1,19 +1,20 @@
 # Naming conventions
-FRAMEWORK_NAME = 'investing investing_algorithm_framework framework'
+FRAMEWORK_NAME = 'investing_algorithm_framework'
 FRAMEWORK_CORE_MODULE_NAME = 'investing_algorithm_framework.core'
-
-# Setting related constants
-SETTINGS_ALGORITHM_PROJECT_NAME = 'ALGORITHM_PROJECT_NAME'
 SETTINGS_MODULE_PATH_ENV_NAME = 'INVESTING_ALGORITHM_FRAMEWORK_SETTINGS_MODULE'
-SETTINGS_DATA_PROVIDER_REGISTERED_APPS = 'INSTALLED_DATA_PROVIDER_APPS'
-SETTINGS_STRATEGY_REGISTERED_APPS = 'INSTALLED_STRATEGY_APPS'
-SETTINGS_MAX_WORKERS = 'DEFAULT_MAX_WORKERS'
+
+# Project related constants
+BASE_DIR = 'BASE_DIR'
+SETTINGS_PROJECT_NAME = 'PROJECT_NAME'
+SETTINGS_MAX_CONCURRENT_WORKERS = 'MAX_CONCURRENT_WORKERS'
 SETTINGS_CONTEXT_CONFIGURATION = 'CONTEXT_CONFIGURATION'
 SETTINGS_LOGGING_CONFIG = 'LOGGING'
 
-# Operational constants
-DEFAULT_MAX_WORKERS = 2
-
 # Database related constants
-BASE_DIR = 'BASE_DIR'
+DATABASE_CONFIG = 'DATABASE_CONFIG'
 DATABASE_NAME = 'DATABASE_NAME'
+DATABASE_TYPE = 'DATABASE_TYPE'
+DATABASE_DIRECTORY_PATH = 'DATABASE_DIRECTORY_PATH'
+DATABASE_URL = 'DATABASE_URL'
+
+DEFAULT_MAX_WORKERS = 2

investing_algorithm_framework/configuration/setup/default_template_creators.py

@@ -91,14 +91,18 @@ def create(self) -> None:
 
                 # Format placeholders in file if needed
                 if filename in [
+                    'Dockerfile-template',
+                    'requirements.txt-template',
                     'manage.py-template',
                     'settings.py-template',
-                    'context.py-template'
+                    'context.py-template',
+                    'extensions.py-template',
+                    'data_providers.py-template',
+                    'strategies.py-template',
+                    'order_executors.py-template'
                 ]:
-
                     # Read the file
                     with open(destination_path, 'r') as file:
-
                         file_data = file.read()
 
                     # Replace the placeholder with the

investing_algorithm_framework/configuration/setup/template_creator.py

@@ -10,6 +10,7 @@ class TemplateCreator(Template, ABC):
     rewrite_template_suffixes = (
         # Allow shipping invalid .py files without byte-compilation.
         ('.py-template', '.py'),
+        ('-template', '')
     )
 
     def __init__(self,  bot_project_directory: str, bot_name: str) -> None:

investing_algorithm_framework/core/context/context.py

@@ -1,10 +1,15 @@
+import logging
 from typing import Type
 
-from investing_algorithm_framework.configuration import settings
+from investing_algorithm_framework.configuration import ContextConfiguration
+from investing_algorithm_framework.configuration.config_constants import \
+    FRAMEWORK_NAME
 from investing_algorithm_framework.core.exceptions import OperationalException
 from investing_algorithm_framework.core.utils import Singleton
 from investing_algorithm_framework.core.state import State
 
+logger = logging.getLogger(FRAMEWORK_NAME)
+
 
 class Context(metaclass=Singleton):
     """
@@ -17,16 +22,16 @@ class Context(metaclass=Singleton):
     _state: State = None
 
     # Settings reference
-    settings = settings
+    _config = ContextConfiguration()
 
     def register_initial_state(self, state: Type[State]) -> None:
         self._state = state(context=self)
 
-    def transition_to(self, bot_state: Type[State]) -> None:
+    def transition_to(self, state: Type[State]) -> None:
         """
         Function to change the running BotState at runtime.
         """
-        self._state = bot_state(context=self)
+        self._state = state(context=self)
 
     def _check_state(self, raise_exception: bool = False) -> bool:
         """
@@ -61,3 +66,7 @@ def _run_state(self) -> None:
         self._state.start()
         transition_state = self._state.get_transition_state_class()
         self.transition_to(transition_state)
+
+    @property
+    def config(self) -> ContextConfiguration:
+        return self._config

investing_algorithm_framework/core/exceptions.py

@@ -14,12 +14,3 @@ class OperationalException(Exception):
     """
     def __init__(self, message) -> None:
         super(OperationalException, self).__init__(message)
-
-
-class DatabaseOperationalException(Exception):
-    """
-    Class DatabaseOperationalException: Exception class indicating a problem
-    occurred during usage of the database
-    """
-    def __init__(self, message) -> None:
-        super(DatabaseOperationalException, self).__init__(message)

investing_algorithm_framework/core/extensions.py

@@ -1,6 +1,4 @@
-from investing_algorithm_framework.core.resolvers.database_resolver \
-    import DatabaseResolver
 from investing_algorithm_framework.core.resolvers.class_resolver \
     import ClassResolver
 
-__all__ = ['DatabaseResolver', 'ClassResolver']
+__all__ = ['ClassResolver']