Merge pull request #15 from investingbots/hotfix_remove_unused_files

Hotfix remove unused files

Author: investingbots

.travis.yml

@@ -0,0 +1,9 @@
+language: python
+
+install:
+  - pip install -r requirements.txt
+
+script: pytest # run test
+
+after_success:
+  - codecov # submit coverage

README.md

@@ -1,69 +1,32 @@
-# Investing bot 
+[![Build Status](https://travis-ci.org/investingbots/investing-bot-framework.svg?branch=master)](https://travis-ci.org/investingbots/investing-bot-framework)
 
-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.
+# Investing Algorithm Framework
 
-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.
+The Investing Algorithm Framework is a free and open source Python framework that encourages rapid development and clean, 
+pragmatic design.
 
-### Disclaimer
-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.
+The goal is to give you a configurable investing algorithm where you can decide how you implement your data providers, 
+strategies, and order executors.
 
-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.
+#####Disclaimer
+If you use this framework for your investments, do not risk money which you are afraid to lose. We can't stress this 
+enough: 
 
-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.
-
-Brokers/Exchange marketplaces supported
-------
-Will be updated in the future 
+BEFORE YOU START USING MONEY WITH THE FRAMEWORK, MAKE SURE THAT YOU TESTED YOUR COMPONENTS THOROUGHLY. USE THE SOFTWARE AT 
+YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR INVESTMENT RESULTS.
 
+Also, make sure that you read the source code of any plugin you use or implementation of an algorithm made with this 
+framework.
 
 Documentation
 ------
-Will be updated in the future 
- 
-## Features
-
-- [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.
-- [ ] **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 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
-
-### Bot commands
-
-
-```
-usage: main.py [-h] [-V] [-c PATH]
-
-Trading bot based on value principles
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default: `config.json`).
-
-```
-
-### Telegram RPC commands
-
-Telegram is not mandatory. However, this is a great way to control your bot.
+All documentation is in the "docs" directory and online at "". If you're just getting started, here's how we recommend 
+you read the docs:
 
+* First, read install for instructions on installing Investing Algorithm Framework.
+* Next, work through the tutorials in order. ("Quickstart", "Template algorithm", "Custom algorithm").
+* For concrete algorithm examples you probably want to read through the topical guides.
+ 
 
 ## Development branches
 
@@ -74,7 +37,6 @@ The project is currently setup in two main branches:
 - `feature/*` - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature.
 - `hotfix/*` - These are hot fix branches, which are being worked on heavily. Please don't use these unless you really need to.
 
-## Support
 
 ### Help / Slack
 

ci/test.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+python3 -m unittest discover -s ../

investing_bot_framework/__init__.py

@@ -0,0 +1,4 @@
+from investing_bot_framework.utils.version import get_version
+
+VERSION = (1, 0, 0, 'alpha', 0)
+

investing_bot_framework/core/configuration/__init__.py

@@ -1,12 +1,13 @@
 import os
+import logging.config
 from typing import Any
 from importlib import import_module
 from enum import Enum
 
 from investing_bot_framework.core.exceptions import ImproperlyConfigured, OperationalException
 from investing_bot_framework.core.configuration.template import Template
-from investing_bot_framework.core.configuration.config_constants import SETTINGS_MODULE_PATH_ENV_NAME, SETTINGS_STRATEGY_REGISTERED_APPS, \
-    SETTINGS_DATA_PROVIDER_REGISTERED_APPS
+from investing_bot_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
 
 
 class TimeUnit(Enum):
@@ -59,14 +60,17 @@ class BaseSettings:
     Base wrapper for settings module. It will load all the default settings for a given settings module
     """
 
-    def __init__(self, settings_module: str = None) -> None:
+    def __init__(self) -> None:
         self._configured = False
-        self._settings_module = settings_module
+        self._settings_module = None
 
-        if self._settings_module is not None:
-            self.configure()
+    def configure(self, settings_module: str = None) -> None:
+        self._settings_module = settings_module
 
-    def configure(self) -> None:
+        if settings_module is None:
+            self.settings_module = os.environ.get(SETTINGS_MODULE_PATH_ENV_NAME)
+        else:
+            self.settings_module = settings_module
 
         if self.settings_module is None:
             raise ImproperlyConfigured("There is no settings module defined")
@@ -93,14 +97,15 @@ def configure(self) -> None:
 
         self._configured = True
 
+        logging.config.dictConfig(self[SETTINGS_LOGGING_CONFIG])
+
     @property
     def settings_module(self) -> str:
         return self._settings_module
 
     @settings_module.setter
     def settings_module(self, settings_module: str) -> None:
         self._settings_module = settings_module
-        self.configure()
 
     @property
     def configured(self) -> bool:
@@ -131,8 +136,4 @@ def get(self, key: str, default: Any = None) -> Any:
         return default
 
 
-def resolve_settings():
-    return BaseSettings(os.environ.get(SETTINGS_MODULE_PATH_ENV_NAME))
-
-
-settings = resolve_settings()
+settings = BaseSettings()

investing_bot_framework/core/configuration/config_constants.py

@@ -8,6 +8,12 @@
 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_LOGGING_CONFIG = 'LOGGING'
 
 # Operational constants
 DEFAULT_MAX_WORKERS = 2
+
+# Database related constants
+BASE_DIR = 'BASE_DIR'
+DATABASE_NAME = 'DATABASE_NAME'

investing_bot_framework/core/context/bot_context.py

@@ -3,7 +3,7 @@
 from investing_bot_framework.core.configuration import settings
 from investing_bot_framework.core.exceptions import OperationalException
 from investing_bot_framework.core.utils import Singleton
-from investing_bot_framework.core.context.states import BotState
+from investing_bot_framework.core.states import BotState
 
 
 class BotContext(metaclass=Singleton):
@@ -18,19 +18,13 @@ class BotContext(metaclass=Singleton):
     # Settings reference
     settings = settings
 
-    def initialize(self, bot_state: Type[BotState]) -> None:
-
-        # Stop the current state of the investing_bot_framework
-        if self._state:
-            self._state.stop()
-
+    def register_initial_state(self, bot_state: Type[BotState]) -> None:
         self._state = bot_state(context=self)
 
     def transition_to(self, bot_state: Type[BotState]) -> None:
         """
         Function to change the running BotState at runtime.
         """
-
         self._state = bot_state(context=self)
 
     def _check_state(self, raise_exception: bool = False) -> bool:
@@ -42,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 "
+                    "Bot context doesn't have a state. Make sure that you set the state of bot either "
                     "by initializing it or making sure that you transition to a new valid state."
                 )
             else:
@@ -66,18 +60,3 @@ def _run_state(self) -> None:
         transition_state = self._state.get_transition_state_class()
         self.transition_to(transition_state)
 
-    def stop(self) -> None:
-        """
-        Stop the current state of the investing_bot_framework
-        """
-
-        self._check_state(raise_exception=True)
-        self._state.stop()
-
-    def reconfigure(self) -> None:
-        """
-        Reconfigure the current state of the investing_bot_framework
-        """
-
-        self._check_state(raise_exception=True)
-        self._state.reconfigure()

investing_bot_framework/core/context/state_validator.py

@@ -4,8 +4,8 @@
 class StateValidator(ABC):
     """
     Class StateValidator: validates the given state. Use this class to change the transition process of a state.
-    Use it as a hook to decide if a state must transition, e.g. only change to a strategy state if all the
-    provided data meets a certain threshold.
+    Use it as a hook to decide if a state must transition, e.g. only change to a strategies state if all the
+    provided data_providers meets a certain threshold.
     """
 
     @abstractmethod