andremog / value-investing-bot

Investing bot based on value investing principles

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Value 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.

Disclaimer

This software is for educational purposes only. Do not risk money which you are afraid to lose. 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.

Exchange marketplaces supported

Will be updated in the future

Documentation

Will be updated in the future

Features

  • Based on Python 3.6+: For botting on any operating system - Windows, macOS and Linux.
  • Persistence: Persistence is achieved through sqlite.
  • Dry-run: Run the bot without playing money.
  • Backtesting: Run a simulation of your buy/sell strategy.
  • 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.
  • 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 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.

  • /help: Show help message
  • /version: Show version
  • /add_tickers: Add tickers to the registry, so they can be analyzed

Development branches

The project is currently setup in two main branches:

  • develop - This branch has often new features, but might also cause breaking changes.
  • master - This branch contains the latest stable release. The bot 'should' be stable on this branch, and is generally well tested.
  • 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

For any questions not covered by the documentation or for further information about the bot, we encourage you to join our slack channel.

Slack

If you discover a bug in the bot, please search our issue tracker first. If it hasn't been reported, please create a new issue and ensure you follow the template guide so that our team can assist you as quickly as possible.

Have you a great idea to improve the bot you want to share? Please, first search if this feature was not already discussed. If it hasn't been requested, please create a new request and ensure you follow the template guide so that it does not get lost in the bug reports.

Feel like our bot is missing a feature? We welcome your pull requests!

Please read our Contributing document to understand the requirements before sending your pull-requests.

Note before starting any major new feature work, please open an issue describing what you are planning to do or talk to us on Slack. This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.

Important: Always create your PR against the develop branch, not master.

Requirements

Uptodate clock

The clock must be accurate, syncronized to a NTP server very frequently to avoid problems with communication to the exchanges.

Min hardware required

To run this bot we recommend you a cloud instance with a minimum of:

  • Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU

In the future raspberry pi support will be added.

Software requirements

About

Investing bot based on value investing principles

License:MIT License


Languages

Language:Python 100.0%