Skip to content

pymargot/margot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2daceb4 · Apr 2, 2023
Jun 30, 2020
Aug 9, 2020
Apr 2, 2023
Jun 10, 2020
Jun 5, 2020
Jun 8, 2020
Jun 29, 2020
Jun 17, 2020
Jun 30, 2020
Jun 10, 2020
Jun 5, 2020
Jun 5, 2020
Jun 17, 2020
Jun 30, 2020
Mar 28, 2023
Jun 10, 2020
Mar 29, 2023
Jun 24, 2020
Jun 5, 2020

Repository files navigation

What is margot?

Margot makes it super easy to backtest trading elgorithms. Firstly, Margot makes it super easy tocreate neat and tidy Pandas dataframes for time-series analysis.

Margot manages data collection, caching, cleaning, feature generation, management and persistence using a clean, declarative API. If you've ever used Django you will find this approach similar to the Django ORM.

Margot also provides a simple framework for writing and backtesting systematic trading algorithms.

Results from margot's trading algorithms can be analysed using pyfolio.

Getting Started

pip install margot

Next you need to make sure you have a couple of important environment variables set::

export ALPHAVANTAGE_API_KEY=YOUR_API_KEY
export DATA_CACHE=PATH_TO_FOLDER_TO_STORE_HDF5_FILES

Once you've done that, try running the code in the notebook.

Status

This is still an early stage software project, and should not be used for live trading just yet.

Documentation

The documentation is at readthedocs.

Contributing

Feel free to make a pull request or chat about your idea first using issues.

Dependencies are kept to a minimum. Generally if there's a way to do something in the standard library (or numpy / Pandas), let's do it that way rather than add another library.

License

Margot is licensed for use under Apache 2.0. For details see the License.