https://github.com/materya/mercury-starter

A starter to use the mercury library for quantitative trading.
https://github.com/materya/mercury-starter

Last synced: 23 days ago
JSON representation

A starter to use the mercury library for quantitative trading.

• Host: GitHub
• URL: https://github.com/materya/mercury-starter
• Owner: materya
• License: gpl-3.0
• Created: 2021-03-11T21:02:52.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-11T21:36:48.000Z (almost 4 years ago)
• Last Synced: 2024-11-08T15:30:58.605Z (3 months ago)
• Language: Python
• Size: 28.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[![License][license-image]][license-url]

A starter to use the [mercury library](https://github.com/materya/mercury) 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](https://code.visualstudio.com/docs/remote/containers) feature.

## Quick start

1. Clone this repo, you know the drill

2. Take a look at [main.py](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](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](https://github.com/pypa/virtualenv) or else) and run `make install` first.

## License

[GPL-3.0](LICENSE)

[license-image]: https://img.shields.io/github/license/materya/mercury-starter?style=flat-square

[license-url]: LICENSE