TradingMate’s documentation

Introduction

TradingMate is an autonomous trading system that uses customised strategies to trade in the London Stock Exchange market. This documentation provides an overview of the system, explaining how to create new trading strategies and how to integrate them with TradingMate. Explore the next sections for a detailed documentation of each module too.

System Overview

TradingMate is a portfolio manager with the goal to help traders to record their trades and deals in the stock market providing useful statistics and metrics to help backtest and review trade performance. It offers a simple user interface that provide information about the current asset value, the overall profit/loss indicator and the trade history.

TradingMate

TradingMate is the main entiy used to initialised all the components. It is the link between the user interface and the data.

TODO

Modules

Each section of this document provides the source code documentation of each component of TradingMate.

TradingMate

Model

The Model module contains the business logic and the data management of TradingMate.

Holding

class Model.Holding.Holding(symbol, quantity, open_price=None)

add_quantity(value)

Add or subtract (if value is negative) the value to the holding quantity

Portfolio

DatabaseHandler

class Model.DatabaseHandler.DatabaseHandler(config, trading_log_path)

Handles the IO operation with the database to handle persistent data

add_trade(trade)

Add a trade to the database

get_db_filepath()

Return the database filepath

get_trades_list()

Return the list of trades stored in the db

get_trading_log_name()

Return the trading log database name

read_data(filepath=None)

Read the trade history from the json database and return the list of trades

• filepath: optional, if not set the configured path will be used

remove_last_trade()

Remove the last trade from the trade history

write_data(filepath=None)

Write the trade history to the database

StockPriceGetter

UI

The UI module contains the components that compose the User Interface of TradingMate.

DataInterface

class UI.DataInterface.DataInterface(client, data_callback)

Thread that periodically requests the most recent data from TradingMate server notify the parent object through a callback function

task()

The task done by this thread - override in subclasses

TradingMateClient

class UI.TradingMateClient.TradingMateClient(server)

Client interface to the TradingMate business logic

delete_last_trade_event(portfolio_id)

Request last trade deletion to the server

get_portfolios()

Get the loaded portfolios

get_settings_event()

Request server to fetch TradingMate settings

is_portfolio_auto_refreshing(portfolio_id)

Return True if portfolio has data auto refresh enabled, False otherwise

manual_refresh_event(portfolio_id)

Request server to refresh portfolio data

new_trade_event(new_trade, portfolio_id)

Push new trade notification to the server

open_portfolio_event(filepath)

Request server to open a portfolio

save_portfolio_event(portfolio_id, filepath)

Request server to save a portfolio

save_settings_event(settings)

Request server to save the settings

set_auto_refresh_event(value, portfolio_id)

Set server to automatically update data for the portfolio

stop()

Handle stop event

unsaved_changes()

Request if open portfolios have unsaved changes and return True

GTK

The gtk module contains the gtk components and widgets of the graphical interface

UIHandler

ConfirmDialog

MessageDialog

PortfolioPage

SettingsWindow

Utils

The Utils module contains all the utlity components.

ConfigurationManager

class Utils.ConfigurationManager.ConfigurationManager(config_path)

Class that loads the configuration and credentials json files exposing static methods to provide the configurable parameters

get_alpha_vantage_api_key()

Get the alphavantage api key

get_alpha_vantage_base_url()

Get the alphavantage API base URI

get_alpha_vantage_polling_period()

Get the alphavantage configured polling period

get_credentials_path()

Get the filepath of the credentials file

get_editable_config()

Get a dictionary containing the editable configuration parameters

get_trading_database_path()

Get the filepath of the trading log file

save_settings(config)

Save the edited configuration settings

TaskThread

class Utils.TaskThread.TaskThread

Thread that executes a task every N seconds

cancel_timeout()

Cancel the timeout and run the task

enable(enabled)

Disable/enable this thread

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

setInterval(interval)

Set the number of seconds we sleep between executing our task

shutdown()

Stop this thread

task()

The task done by this thread - override in subclasses

Trade

class Utils.Trade.Trade(date_string, action, quantity, symbol, price, fee, sdr, notes)

Utils

class Utils.Utils.Actions

An enumeration.

class Utils.Utils.Messages

An enumeration.

class Utils.Utils.Markets

An enumeration.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2.1.1] - 2020-01-13

Changed

• Removed unused resource files

• Updated README

[2.1.0] - 2020-01-12

Changed

• Replaced TK user interface with GTK+ 3

• Tickers prices are fetched using alpha-vantage Python module

• alpha_vantage_polling_period configuration parameter is used to wait between each AV call

• AlphaVantage http requests are thread safe

Added

• Status bar showing portfolio filepath

• Button to open a new window tailing the current application log file

[2.0.0] - 2019-12-14

Changed

• Issue37 - Improved installation process and dependencies setup

• Updated default .credentials configured path

• Re-design of system architecture and API

• Edited Portfolios are not saved automatically and a warning is displayed

Added

• Added Pipfile to manage python dependencies

• Added FEE action

• Added notes field in trade

• Support load of multiple portfolios

• Save As and Save buttons per portfolio

[1.0.0] 2019-05-03

Added

• Initial release