Merge pull request #28 from investing-algorithms/hotfix_templates

Hotfix templates

Author: investing-algorithms

investing_algorithm_framework/__main__.py

@@ -1,6 +1,6 @@
 """
 Invokes investing_algorithm_framework-admin when the investing_algorithm_framework framework module is run as a script.
-Example: python -m investing_algorithm_framework createbot SampleBot
+Example: python -m investing_algorithm_framework createalgorithm SampleAlgorithm
 """
 
 from investing_algorithm_framework.core.management import execute_from_command_line

investing_algorithm_framework/core/configuration/config_constants.py

@@ -3,12 +3,12 @@
 FRAMEWORK_CORE_MODULE_NAME = 'investing_algorithm_framework.core'
 
 # Setting related constants
-SETTINGS_BOT_PROJECT_NAME = 'BOT_PROJECT_NAME'
-SETTINGS_MODULE_PATH_ENV_NAME = 'INVESTING_BOT_FRAMEWORK_SETTINGS_MODULE'
+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'
-SETTINGS_BOT_CONTEXT_CONFIGURATION = 'BOT_CONTEXT_CONFIGURATION'
+SETTINGS_CONTEXT_CONFIGURATION = 'CONTEXT_CONFIGURATION'
 SETTINGS_LOGGING_CONFIG = 'LOGGING'
 
 # Operational constants

investing_algorithm_framework/core/configuration/setup/__init__.py

@@ -1 +1 @@
-from investing_algorithm_framework.core.configuration.setup.default_template_creators import DefaultBotProjectCreator
+from investing_algorithm_framework.core.configuration.setup.default_template_creators import DefaultProjectCreator

investing_algorithm_framework/core/configuration/setup/default_template_creators.py

@@ -6,16 +6,16 @@
 from investing_algorithm_framework.core.configuration.setup.template_creator import TemplateCreator
 
 
-class DefaultBotProjectCreator(TemplateCreator):
-    TEMPLATE_ROOT_DIR = 'templates/bot_project_directory'
-    BOT_PROJECT_NAME_PLACEHOLDER = '{{ bot_project_name }}'
-    BOT_PROJECT_TEMPLATE_DIR_NAME = 'bot_project_template'
+class DefaultProjectCreator(TemplateCreator):
+    TEMPLATE_ROOT_DIR = 'templates/algorithm_project_directory'
+    PROJECT_NAME_PLACEHOLDER = '{{ project_name }}'
+    PROJECT_TEMPLATE_DIR_NAME = 'algorithm_project_template'
 
     def configure(self) -> None:
         bot_dir = os.path.join(self._bot_project_directory, self._bot_name)
 
         if os.path.exists(bot_dir):
-            raise ImproperlyConfigured("Bot destination directory {} already exists".format(self._bot_name))
+            raise ImproperlyConfigured("Project destination directory {} already exists".format(self._bot_name))
 
     def create(self) -> None:
 
@@ -29,7 +29,7 @@ def create(self) -> None:
             path_rest = root[len(template_dir) + 1:]
 
             # Replace template investing_algorithm_framework directory with given investing_algorithm_framework name
-            path_rest = path_rest.replace(self.BOT_PROJECT_TEMPLATE_DIR_NAME, self._bot_name)
+            path_rest = path_rest.replace(self.PROJECT_TEMPLATE_DIR_NAME, self._bot_name)
 
             # Create the directories if they don't exist
             destination_dir = os.path.join(self._bot_project_directory, path_rest)
@@ -76,15 +76,15 @@ def create(self) -> None:
                     )
 
                 # Format placeholders in file if needed
-                if filename in ['manage.py-template', 'settings.py-template']:
+                if filename in ['manage.py-template', 'settings.py-template', 'context.py-template']:
 
                     # Read the file
                     with open(destination_path, 'r') as file:
 
                         file_data = file.read()
 
                     # Replace the placeholder with the investing_algorithm_framework name
-                    file_data = file_data.replace(self.BOT_PROJECT_NAME_PLACEHOLDER, self._bot_name)
+                    file_data = file_data.replace(self.PROJECT_NAME_PLACEHOLDER, self._bot_name)
 
                     # Write the file out again
                     with open(destination_path, 'w') as file:

investing_algorithm_framework/core/configuration/template.py

@@ -10,8 +10,9 @@ class Template:
 
     def __init__(self, bot_project_directory: str, bot_name: str) -> None:
         """
-        investing_algorithm_framework project directory is the root directory of the given investing_algorithm_framework. The bot_name will be the same as the root project
-        directory. For simplicity it is explicitly passed as a parameter
+        investing_algorithm_framework project directory is the root directory of the given
+        investing_algorithm_framework. The algorithm_name will be the same as the root project directory. For
+        simplicity it is explicitly passed as a parameter
         """
 
         if bot_project_directory is None:

investing_algorithm_framework/core/context/__init__.py

@@ -1 +1 @@
-from investing_algorithm_framework.core.context.bot_context import BotContext
+from investing_algorithm_framework.core.context.context import Context

investing_algorithm_framework/core/context/bot_context.py renamed to investing_algorithm_framework/core/context/context.py

@@ -6,13 +6,13 @@
 from investing_algorithm_framework.core.states import BotState
 
 
-class BotContext(metaclass=Singleton):
+class Context(metaclass=Singleton):
     """
-    The BotContext defines the current state of the running bot. It also maintains a reference to an instance of a
-    BotState subclass, which represents the current state of the BotContext.
+    The Context defines the current state of the running algorithms. It also maintains a reference to an instance of a
+    state subclass, which represents the current state of the context instance.
     """
 
-    # A reference to the current state of the Bot Context.
+    # A reference to the current state of the context.
     _state: BotState = None
 
     # Settings reference
@@ -36,7 +36,7 @@ def _check_state(self, raise_exception: bool = False) -> bool:
 
             if raise_exception:
                 raise OperationalException(
-                    "Bot context doesn't have a state. Make sure that you set the state of bot either "
+                    "Context doesn't have a state. Make sure that you set the state either "
                     "by initializing it or making sure that you transition to a new valid state."
                 )
             else:

investing_algorithm_framework/core/data_providers/data_provider.py

@@ -23,11 +23,11 @@ def __str__(self) -> str:
 
 class DataProvider(ScheduledWorker):
     """
-    Class DataProvider: An entity which responsibility is to provide data_providers from an external data_providers
-    source. Where a data_providers source is defined as any third party service that provides data_providers,
-    e.g  cloud storage, REST API, or website.
+    Class DataProvider: An entity which responsibility is to provide data from an external source.
+    Where a data_providers source is defined as any third party service that provides data e.g  cloud storage,
+    REST API, or website.
 
-    A data_providers provider must always be run with the start function from it´s super class. Otherwise depend
+    A data_provider must always be run with the start function from it´s super class. Otherwise depended
     observers will not be updated.
     """
 

investing_algorithm_framework/core/data_providers/mixins/__init__.py

@@ -4,43 +4,43 @@
 
 from investing_algorithm_framework.core.exceptions import ImproperlyConfigured
 from investing_algorithm_framework.core.management.command import BaseCommand, CommandError
-from investing_algorithm_framework.core.configuration.setup import DefaultBotProjectCreator
+from investing_algorithm_framework.core.configuration.setup.default_template_creators import DefaultProjectCreator
 
 
-class CreateBotCommand(BaseCommand):
+class CreateAlgorithmCommand(BaseCommand):
     help = (
-        "Creates a project directory structure for the given investing_algorithm_framework name in the current directory or optionally "
-        "in the given directory."
+        "Creates a project directory structure for the given investing_algorithm_framework instance in the current "
+        "directory or optionally in the given directory."
     )
 
-    missing_args_message = "You must provide a investing_algorithm_framework name."
-    success_message = "Bot created and initialized."
+    missing_args_message = "You must provide a project name."
+    success_message = "Algorithm created and initialized."
 
     def add_arguments(self, parser):
-        parser.add_argument('name', help='Name of the investing_algorithm_framework.')
+        parser.add_argument('name', help='Name of the algorithm/project.')
         parser.add_argument('directory', nargs='?', help='Optional destination directory')
         parser.add_argument(
             '--template_creator',
             help='Optional template creator plugin, provided by third party libraries'
         )
 
-    def handle(self, **options) -> str:
+    def handle(self, **options) -> None:
 
         # Get all the default attributes
-        bot_name = options.get('name', None)
+        project_name = options.get('name', None)
         directory = options.get('directory', None)
         template_creator = options.get('template_creator', None)
 
-        self.validate_name(bot_name)
+        self.validate_name(project_name)
 
         # initialize the investing_algorithm_framework project directory
         if directory is None:
-            directory = os.path.join(os.getcwd(), bot_name)
+            directory = os.path.join(os.getcwd(), project_name)
 
             if os.path.isdir(directory):
                 raise ImproperlyConfigured(
-                    "Directory {} already exists. Please make sure that the investing_algorithm_framework project name does not correspond to "
-                    "an existing directory"
+                    "Directory {} already exists. Please make sure that the project "
+                    "name does not correspond to an existing directory".format(str(directory))
                 )
 
             os.mkdir(directory)
@@ -49,24 +49,26 @@ def handle(self, **options) -> str:
             directory = os.path.abspath(os.path.expanduser(directory))
 
             if not os.path.exists(directory):
-                raise CommandError("Destination directory {} does not exist, please create it first.".format(directory))
+                raise CommandError(
+                    "Destination directory {} does not exist, please create it first.".format(str(directory))
+                )
 
         # Use default investing_algorithm_framework creator
         if not template_creator:
-            bot_template_creator = DefaultBotProjectCreator(directory, bot_name)
+            template_creator = DefaultProjectCreator(directory, project_name)
 
         # Creates templates
-        bot_template_creator.configure()
-        bot_template_creator.create()
+        template_creator.configure()
+        template_creator.create()
 
     @staticmethod
     def validate_name(name: str) -> None:
         """
-        Helper function to validate the name of a given investing_algorithm_framework
+        Helper function to validate the name of a given project
         """
 
         if name is None:
-            raise CommandError("you must provide a investing_algorithm_framework name")
+            raise CommandError("you must provide a project name")
 
         if not re.match("^[a-zA-Z]+\w*$", name):
             raise CommandError("{} is not allowed, value must begin with a letter and "
@@ -80,6 +82,6 @@ def validate_name(name: str) -> None:
         else:
             raise CommandError(
                 "'{}' conflicts with the name of an existing Python "
-                "module and cannot be used as a investing_algorithm_framework name. Please try "
+                "module and cannot be used as a project name. Please try "
                 "another name.".format(name)
             )

investing_algorithm_framework/core/data_providers/mixins/rest_api_mixin.py

@@ -17,7 +17,7 @@ def add_arguments(self, parser) -> None:
     def handle(self) -> Any:
         usage = [
             "",
-            "This is the command line management for the investing investing_algorithm_framework framework. \n"
+            "This is the command line management for the investing algorithm framework. \n"
             "Type help <sub_command>' for help on a specific sub command.",
             "",
             "Available sub commands:",

investing_algorithm_framework/core/management/commands/createbot.py renamed to investing_algorithm_framework/core/management/commands/create_algorithm.py

@@ -0,0 +1,36 @@
+from typing import Any
+
+from investing_algorithm_framework.core.management.command import BaseCommand, CommandError
+from investing_algorithm_framework.core.context import Context
+from investing_algorithm_framework.core.configuration.config_constants import SETTINGS_CONTEXT_CONFIGURATION
+from investing_algorithm_framework.core.configuration import settings
+
+
+class RunAlgorithmCommand(BaseCommand):
+    help_message = (
+        "Runs a instance of an algorithm created with the investing_algorithm_framework, by default it will run "
+        "until stopped, if cycles is specified it will run the according to the amount of cycles"
+    )
+
+    success_message = (
+        "Algorithm is finished running"
+    )
+
+    def add_arguments(self, parser) -> None:
+        pass
+
+    def handle(self, *args, **options) -> Any:
+
+        # configure settings
+        settings.configure()
+
+        # Load the context configuration
+        __import__(settings[SETTINGS_CONTEXT_CONFIGURATION])
+
+        # Create an investing_algorithm_framework context of the investing_algorithm_framework and run it
+        context = Context()
+        context.start()
+
+
+
+