investing-algorithm-framework 0.1

A framework for creating an investment algorithm

Investing Algorithm Framework

The Investing Algorithm Framework is a python framework to build investment algorithms. It encourages rapid development and clean, pragmatic design. It is free for personal usage.

In most cases, you'll probably never have to change code on this repo directly if you are building your algorithm/bot. But if you do, check out CONTRIBUTING.md

If you'd like to chat with investing-algorithm-framework users and developers, join us on Slack

Disclaimer

If you use this framework for your investments, do not risk money which you are afraid to lose. We can't stress this enough:

BEFORE YOU START USING MONEY WITH THE FRAMEWORK, MAKE SURE THAT YOU TESTED YOUR COMPONENTS THOROUGHLY. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR INVESTMENT RESULTS.

Also, make sure that you read the source code of any plugin you use or implementation of an algorithm made with this framework.

Acknowledgements

We want to thank all contributors to this project. A full list of all the people that contributed to the project can be found here

Documentation

All documentation can be found online at the official website here here.

For a quick guide on installing the framework look here

Help / Slack

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

join us on Slack

Bugs / Issues

If you discover a bug in the framework, please search our issue tracker first. If it hasn't been reported, please create a new issue.

Feel like the framework 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 feature or hotfix against the develop branch, not master.