Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.45 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.45 KB
Raw

Mercury Materya Starter Kit

License

A starter to use the mercury library for quantitative trading.

This is a base example and is not meant to be ready out of the box.

A container environment is available to run the trading engine, you can also use the VSCode Development Container feature.

Quick start

  1. Clone this repo, you know the drill
  2. Take a look at main.py for a basic setup of the mercury engine and tweak as you like. You need at least a stragegy and a broker.
  3. You can use the config.cfg example to configure your engine. In a production context it is strongly advised to use either environment variables, kubernetes secrets or any kind of vault/protection on sensible parameters.
  4. You can start the engine with a make run either locally or in the container, the Makefile will detect the context and ensure to run in the container.

Local setup

If you want to use this starter locally, ensure you have properly setup your environment with python >= 3.6 (with virtualenv or else) and run make install first.

License

GPL-3.0