Merge pull request #32 from investing-algorithms/feature_core

Rearrange core package

Author: investing-algorithms

bin/investing-algorithm-framework-admin

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from investing_algorithm_framework.core.management import execute_from_command_line
+from investing_algorithm_framework.management import execute_from_command_line
 
 if __name__ == "__main__":
     execute_from_command_line()

investing_algorithm_framework/__main__.py

@@ -1,9 +1,9 @@
 """
 Invokes investing_algorithm_framework-admin when the investing_algorithm_framework framework module is run as a script.
-Example: python -m investing_algorithm_framework createalgorithm SampleAlgorithm
+Example: python -m investing_algorithm_framework create_standard_algo SampleAlgorithm
 """
 
-from investing_algorithm_framework.core.management import execute_from_command_line
+from investing_algorithm_framework.management import execute_from_command_line
 
 if __name__ == "__main__":
     execute_from_command_line()

investing_algorithm_framework/core/configuration/__init__.py renamed to investing_algorithm_framework/configuration/__init__.py

@@ -5,13 +5,11 @@
 from enum import Enum
 
 from investing_algorithm_framework.core.exceptions import ImproperlyConfigured, OperationalException
-from investing_algorithm_framework.core.configuration.template import Template
-from investing_algorithm_framework.core.configuration.config_constants import SETTINGS_MODULE_PATH_ENV_NAME, \
-    SETTINGS_STRATEGY_REGISTERED_APPS, SETTINGS_DATA_PROVIDER_REGISTERED_APPS, BASE_DIR, SETTINGS_LOGGING_CONFIG
+from investing_algorithm_framework.configuration.config_constants import SETTINGS_MODULE_PATH_ENV_NAME, \
+    SETTINGS_STRATEGY_REGISTERED_APPS, SETTINGS_DATA_PROVIDER_REGISTERED_APPS, SETTINGS_LOGGING_CONFIG
 
 
 class TimeUnit(Enum):
-
     SECOND = 'SEC',
     MINUTE = 'MIN',
     HOUR = 'HR',

investing_algorithm_framework/core/configuration/config_constants.py renamed to investing_algorithm_framework/configuration/config_constants.py

@@ -0,0 +1 @@
+from investing_algorithm_framework.configuration.setup.default_template_creators import DefaultProjectCreator

investing_algorithm_framework/configuration/setup/__init__.py

@@ -3,11 +3,11 @@
 
 import investing_algorithm_framework
 from investing_algorithm_framework.core.exceptions import ImproperlyConfigured
-from investing_algorithm_framework.core.configuration.setup.template_creator import TemplateCreator
+from investing_algorithm_framework.configuration.setup.template_creator import TemplateCreator
 
 
 class DefaultProjectCreator(TemplateCreator):
-    TEMPLATE_ROOT_DIR = 'templates/algorithm_project_directory'
+    TEMPLATE_ROOT_DIR = 'templates/projects/algorithm_project_directory'
     PROJECT_NAME_PLACEHOLDER = '{{ project_name }}'
     PROJECT_TEMPLATE_DIR_NAME = 'algorithm_project_template'
 

investing_algorithm_framework/core/configuration/setup/default_template_creators.py renamed to investing_algorithm_framework/configuration/setup/default_template_creators.py

@@ -2,7 +2,7 @@
 import stat
 from abc import ABC, abstractmethod
 
-from investing_algorithm_framework.core.configuration import Template
+from investing_algorithm_framework.configuration.setup.template import Template
 
 
 class TemplateCreator(Template, ABC):

investing_algorithm_framework/core/configuration/template.py renamed to investing_algorithm_framework/configuration/setup/template.py

@@ -1,9 +1,9 @@
 from typing import Type
 
-from investing_algorithm_framework.core.configuration import settings
+from investing_algorithm_framework.configuration import settings
 from investing_algorithm_framework.core.exceptions import OperationalException
 from investing_algorithm_framework.core.utils import Singleton
-from investing_algorithm_framework.core.states import BotState
+from investing_algorithm_framework.core.state import State
 
 
 class Context(metaclass=Singleton):
@@ -13,15 +13,15 @@ class Context(metaclass=Singleton):
     """
 
     # A reference to the current state of the context.
-    _state: BotState = None
+    _state: State = None
 
     # Settings reference
     settings = settings
 
-    def register_initial_state(self, bot_state: Type[BotState]) -> None:
-        self._state = bot_state(context=self)
+    def register_initial_state(self, state: Type[State]) -> None:
+        self._state = state(context=self)
 
-    def transition_to(self, bot_state: Type[BotState]) -> None:
+    def transition_to(self, bot_state: Type[State]) -> None:
         """
         Function to change the running BotState at runtime.
         """