Merge pull request #8 from investingbots/develop

Develop

Author: investingbots

README.md

@@ -1,40 +1,46 @@
-# Value investing bot 
+# Investing bot 
 
-The value investing bot is a free and open source investing bot written in Python. It is designed to support all 
-major exchanges and be controlled via Telegram. It contains backtesting, plotting and money management tools.
+The investing bot is a free and open source investing bot written in Python. The goal is to give you a configurable bot 
+where you can decide on how you implement your data providers, strategies, and brokers/exchanges. Also we want to allow 
+you to let your bot facilitate multiple users.
+
+It is designed to be controlled via Telegram. As of now, we are aiming to make the configuration of the different 
+components by the use of plugins. Please see the documentation on how to make your own plugin.
 
 ### Disclaimer
-This software is for educational purposes only. Do not risk money which you are afraid to lose. 
+This software is for educational purposes only. Do not risk money which you are afraid to lose. We can't stress this 
+enough: BEFORE YOU START USING MONEY WITH THE BOT, MAKE SURE THAT YOU TESTED YOU STRATEGIES AND DATA PROVIDERS.  
 USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
 
 Always start by running a investing bot in Dry-run and do not engage money before you understand how it works and what profit/loss you should expect.
 
-We strongly recommend you to have coding and Python knowledge. Do not hesitate to read the source code and understand the mechanism of this bot.
+We strongly recommend you to have coding and Python knowledge, or trust the people that created the plugins your using. 
+Do not hesitate to read the source code and understand the mechanism of this bot or the plugin you're using.
 
-Exchange marketplaces supported
+Brokers/Exchange marketplaces supported
 ------
 Will be updated in the future 
 
+
 Documentation
 ------
 Will be updated in the future 
 
 ## Features
 
-- [x] **Based on Python 3.6+**: For botting on any operating system - Windows, macOS and Linux.
+- [x] **Based on Python 3.6+**: Support for all operating systems - Windows, macOS and Linux.
 - [x] **Persistence**: Persistence is achieved through sqlite.
 - [ ] **Dry-run**: Run the bot without playing money.
+- [ ] **REST API**: Manage the bot with the use of a REST API.
 - [ ] **Backtesting**: Run a simulation of your buy/sell strategy.
-- [x] **Tracking of companies**: Add, remove and track companies to track. 
-- [ ] **Stock selection**: Select which stocks you want to trade or want to track by creating a subselection.
-- [x] **Manageable via Telegram**: Manage the bot with Telegram.
+- [ ] **Manageable via Telegram**: Manage the bot with Telegram.
 - [ ] **Display profit/loss**: Display your profit/loss.
 - [ ] **Daily summary of profit/loss**: Provide a daily summary of your profit/loss.
 - [ ] **Performance status report**: Provide a performance status of your current trades.
 
 ## Quick start
 
-The value investing bot provides a Linux/macOS script to install all dependencies and help you to configure the bot.
+The investing bot provides a Linux/macOS script to install all dependencies and help you to configure the bot.
 
 The script will come as a future update
 
@@ -58,10 +64,6 @@ optional arguments:
 
 Telegram is not mandatory. However, this is a great way to control your bot.
 
-- `/help`: Show help message
-- `/version`: Show version
-- `/add_tickers`: Add tickers to the registry, so they can be analyzed
-
 
 ## Development branches
 

bot/configuration/resolvers.py

@@ -1,152 +1,66 @@
 from typing import Dict, Any, List
 
-from bot.strategies import Strategy
 from bot.data import DataProvider
-from bot import DependencyException, OperationalException
-from bot.remote_loaders import StrategyRemoteLoader, DataProviderRemoteLoader
+from bot.constants import TimeUnit
+from bot import DependencyException
+from bot.remote_loaders import DataProviderRemoteLoader
 
 
 def get_data_provider_configurations(config: Dict[str, Any]) -> List[Dict[str, Any]]:
-    data_provider_configurations = config.get('data_providers', {})
+    """
+    Function that validates and loads all the data provider definitions for the given configuration
+    """
+    data_providers_configuration = config.get('data_providers', None)
 
-    entries = []
+    if data_providers_configuration is None:
+        raise DependencyException("Data providers are not defined in the config. Please make sure that you "
+                                  "define some data providers. If you have difficulties creating a data provider, "
+                                  "please see the documentation for examples.")
 
-    if not data_provider_configurations:
-        raise DependencyException(
-            "Could not resolve data providers, please provide the data provider configurations in your config file. "
-            "You could also use de default data providers, that can be found in the data/data_provider/templates"
-            " directory. If you have difficulties creating your own data provider, please see the documentation"
-        )
-
-    for data_provider_entry in data_provider_configurations.keys():
-        entry = {
-            'key': data_provider_entry,
-            'class_name': data_provider_configurations[data_provider_entry].get('class_name', None),
-            'enabled': bool(data_provider_configurations[data_provider_entry].get('enabled', False)),
-            'plugin': bool(data_provider_configurations[data_provider_entry].get('plugin', False))
-        }
-        entries.append(entry)
-
-    return entries
-
-
-def get_strategy_configurations(config: Dict[str, Any]) -> List[Dict[str, Any]]:
-    strategy_configurations = config.get('strategies', {})
+    for data_provider_config in data_providers_configuration:
 
-    entries = []
-
-    if not strategy_configurations:
-        raise DependencyException(
-            "Could not resolve strategies, please provide the strategy configurations in your config file. "
-            "You could also use de default strategies, that can be found in the "
-            "strategies/strategy/templates directory. If you have difficulties creating "
-            "your own strategies, please see the documentation"
+        assert data_provider_config.get('class_name', None) is not None, (
+            "Expected data provider to define a class_name. Please fix your data provider configuration."
         )
 
-    for strategy_entry in strategy_configurations.keys():
-        entry = {
-            'key': strategy_entry,
-            'class_name': strategy_configurations[strategy_entry].get('class_name', None),
-            'enabled': bool(strategy_configurations[strategy_entry].get('enabled', False)),
-            'plugin': bool(strategy_configurations[strategy_entry].get('plugin', False))
-        }
-        entries.append(entry)
-
-    return entries
-
-
-def get_data_provider_plugins(data_provider_configurations: List[Dict[str, Any]]) -> List[DataProvider]:
-    remote_loader = DataProviderRemoteLoader()
-    data_providers = []
-
-    for entry in data_provider_configurations:
-
-        if not entry.get('enabled', False):
-            continue
+        assert data_provider_config.get('schedule', None) is not None, (
+            "Expected data provider {} to define an schedule. Please fix your data provider "
+            "configuration.".format(data_provider_config.get('class_name'))
+        )
 
-        if not entry.get('key', None):
-            raise DependencyException("Configured data provider must specify a identifier name")
+        if not TimeUnit.ALWAYS.equals(data_provider_config.get('schedule')):
 
-        if not entry.get('class_name', None):
-            raise DependencyException(
-                "Configured data provider {} must specify a class name corresponding "
-                "to the data provider implementation".format(entry)
+            assert data_provider_config.get('schedule').get('time_unit', None) is not None, (
+                "Expected data provider {} to define an schedule time_unit. Please fix your data provider "
+                "configuration.".format(data_provider_config.get('class_name'))
             )
 
-        if not bool(entry.get('plugin', False)):
-            continue
-
-        data_provider: DataProvider = remote_loader.load_data_provider(entry.get('class_name'))
-        data_providers.append(data_provider)
-
-    return data_providers
-
-
-def get_data_provider_templates(data_provider_configurations: List[Dict[str, Any]]) -> List[DataProvider]:
-    data_providers = []
-
-    for entry in data_provider_configurations:
-
-        if not entry.get('key', None):
-            raise DependencyException("Configured data provider must specify a identifier name")
-
-        if bool(entry.get('plugin', False)):
-            continue
-
-        if entry.get("key") == "":
-            continue
-
-        # data_provider: DataProvider = remote_loader.load_data_provider(entry.get('class_name'))
-        # data_providers.append(data_provider)
-
-    return None
-
-
-def get_strategy_plugins(strategy_configurations: List[Dict[str, Any]]) -> List[Strategy]:
-    remote_loader = StrategyRemoteLoader()
-    strategies = []
-
-    for entry in strategy_configurations:
-
-        if not entry.get('enabled', False):
-            continue
-
-        if not entry.get('key', None):
-            raise DependencyException("Configured strategy must specify a identifier name")
-
-        if not entry.get('class_name', None):
-            raise DependencyException(
-                "Configured strategy {} must specify a class name corresponding "
-                "to the strategy implementation".format(entry)
+            assert data_provider_config.get('schedule').get('interval', None) is not None, (
+                "Expected data provider {} to define an schedule interval. Please fix your data provider "
+                "configuration.".format(data_provider_config.get('class_name'))
             )
 
-        if not bool(entry.get('plugin', False)):
-            continue
-
-        strategy: Strategy = remote_loader.load_strategy(entry.get('class_name'))
-        strategies.append(strategy)
-
-    return strategies
-
-
-def get_strategy_templates(strategy_configurations: List[Dict[str, Any]]) -> List[Strategy]:
-    strategies = []
+        assert data_provider_config.get('plugin', None) is not None, (
+            "Expected provider for data provider {} to define plugin flag. Please fix your data provider "
+            "configuration. If you make use of one of the templates set the flag to "
+            "false.".format(data_provider_config.get('class_name'))
+        )
 
-    for entry in strategy_configurations:
+    return data_providers_configuration
 
-        if not entry.get('key', None):
-            raise DependencyException("Configured data provider must specify a identifier name")
 
-        if bool(entry.get('plugin', False)):
-            continue
+def load_data_provider(data_provider_configuration: Dict[str, str]) -> DataProvider:
 
-        if entry.get("key") == "":
-            continue
+    class_name = data_provider_configuration.get('class_name')
+    plugin = bool(data_provider_configuration.get('plugin'))
+    data_provider: DataProvider = None
 
-        # data_provider: DataProvider = remote_loader.load_data_provider(entry.get('class_name'))
-        # data_providers.append(data_provider)
+    if plugin:
+        remote_loader = DataProviderRemoteLoader()
+        return remote_loader.load_data_provider(class_name)
+    else:
+        return None
 
-    return None
 
 
 

bot/constants.py

@@ -1,30 +1,74 @@
 from enum import Enum
-from bot.settings import BASE_DIR, PLUGIN_STRATEGIES_DIR, PLUGIN_DATA_PROVIDERS_DIR
+
+from bot import OperationalException
+from bot.settings import BASE_DIR, PLUGIN_STRATEGIES_DIR, PLUGIN_DATA_PROVIDERS_DIR, TEST_CONFIGURATION_RESOURCES, \
+    TEST_DATA_PROVIDER_RESOURCES, TEST_RESOURCES
 """
 bot constants
 """
+
+# Configuration
 DEFAULT_CONFIG = 'config.json'
-DEFAULT_MAX_WORKERS = 2
 BASE_DIR = BASE_DIR
+
+# Executor configuration
+DEFAULT_MAX_WORKERS = 2
+
+# Strategies
 PLUGIN_STRATEGIES_DIR = PLUGIN_STRATEGIES_DIR
+
+# Data providers
 PLUGIN_DATA_PROVIDERS_DIR = PLUGIN_DATA_PROVIDERS_DIR
 
+# Test resources
+TEST_CONFIGURATION_RESOURCES = TEST_CONFIGURATION_RESOURCES
+TEST_DATA_PROVIDER_RESOURCES = TEST_DATA_PROVIDER_RESOURCES
+TEST_RESOURCES = TEST_RESOURCES
+
 
 class TimeUnit(Enum):
 
-    second = 'SEC',
-    minute = 'MIN',
-    hour = 'HR'
+    SECOND = 'SEC',
+    MINUTE = 'MIN',
+    HOUR = 'HR',
+    ALWAYS = 'ALWAYS'
 
-    # Static factory method to convert a string to TimeUnit
+    # Static factory method to convert a string to time_unit
     @staticmethod
     def from_string(value: str):
 
-        if value in ('SEC' 'sec', 'SECOND', 'second', 'SECONDS', 'seconds'):
-            return TimeUnit.second
+        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
+
 
-        elif value in ('MIN', 'min', 'MINUTE', 'minute', 'MINUTES', 'minutes'):
-            return TimeUnit.minute
 
-        elif value in ('HR', 'hr', 'HOUR', 'hour', 'HOURS', 'hour'):
-            return

bot/context/__init__.py

@@ -1 +1,3 @@
-from bot.context.bot_context import BotContext
+# from bot.context.setup_state import SetupState
+# from bot.context.data_providing_state import DataProvidingState
+from bot.context.bot_context import BotContext, ExecutionScheduler

bot/context/analyzing_state.py

@@ -1,13 +1,26 @@
+import logging
+
 from bot.context.bot_state import BotState
 
+logger = logging.getLogger(__name__)
+
 
 class AnalyzingState(BotState):
 
-    def run(self):
-        pass
+    def __init__(self, context):
+        logger.info("Initializing analyzing state ...")
+
+        super(AnalyzingState, self).__init__(context)
+
+    def run(self) -> None:
+        logger.info("Analyzing state started ...")
+
+        from bot.context.data_providing_state import DataProvidingState
+        self.context.transition_to(DataProvidingState)
+        self.context.run()
 
-    def stop(self):
+    def stop(self) -> None:
         pass
 
-    def reconfigure(self):
+    def reconfigure(self) -> None:
         pass