|
2 | 2 |
|
3 | 3 | # Investing Algorithm Framework |
4 | 4 |
|
5 | | -The Investing Algorithm Framework is a free and open source Python framework that encourages rapid development and clean, |
6 | | -pragmatic design. |
| 5 | +The Investing Algorithm Framework is a python framework to build investment algorithms. It encourages rapid development and clean, |
| 6 | +pragmatic design. It is free for personal usage and open source. |
7 | 7 |
|
8 | | -The goal is to give you a configurable investing algorithm where you can decide how you implement your data providers, |
9 | | -strategies, and order executors. |
| 8 | +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 |
10 | 9 |
|
11 | | -#####Disclaimer |
12 | | -If you use this framework for your investments, do not risk money which you are afraid to lose. We can't stress this |
13 | | -enough: |
| 10 | +If you'd like to chat with investing-algorithm-framework users and developers, [join us on Slack](https://inv-algo-framework.slack.com) |
14 | 11 |
|
15 | | -BEFORE YOU START USING MONEY WITH THE FRAMEWORK, MAKE SURE THAT YOU TESTED YOUR COMPONENTS THOROUGHLY. USE THE SOFTWARE AT |
| 12 | +#### Disclaimer |
| 13 | +If you use this framework for your investments, do not risk money which you are afraid to lose. We can't stress this |
| 14 | +enough: |
| 15 | + |
| 16 | +BEFORE YOU START USING MONEY WITH THE FRAMEWORK, MAKE SURE THAT YOU TESTED YOUR COMPONENTS THOROUGHLY. USE THE SOFTWARE AT |
16 | 17 | YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR INVESTMENT RESULTS. |
17 | 18 |
|
18 | | -Also, make sure that you read the source code of any plugin you use or implementation of an algorithm made with this |
| 19 | +Also, make sure that you read the source code of any plugin you use or implementation of an algorithm made with this |
19 | 20 | framework. |
20 | 21 |
|
21 | | -Documentation |
22 | | ------- |
23 | | -All documentation is in the "docs" directory and online at "". If you're just getting started, here's how we recommend |
24 | | -you read the docs: |
25 | | - |
26 | | -* First, read install for instructions on installing Investing Algorithm Framework. |
27 | | -* Next, work through the tutorials in order. ("Quickstart", "Template algorithm", "Custom algorithm"). |
28 | | -* For concrete algorithm examples you probably want to read through the topical guides. |
29 | | - |
30 | | - |
31 | | -## Development branches |
32 | | - |
33 | | -The project is currently setup in two main branches: |
34 | | - |
35 | | -- `develop` - This branch has often new features, but might also cause breaking changes. |
36 | | -- `master` - This branch contains the latest stable release. The bot 'should' be stable on this branch, and is generally well tested. |
37 | | -- `feature/*` - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature. |
38 | | -- `hotfix/*` - These are hot fix branches, which are being worked on heavily. Please don't use these unless you really need to. |
39 | | - |
| 22 | +## Documentation |
| 23 | +All documentation can be found online at "". |
40 | 24 |
|
41 | 25 | ### Help / Slack |
42 | 26 |
|
43 | 27 | For any questions not covered by the documentation or for further |
44 | | -information about the bot, we encourage you to join our slack channel. |
| 28 | +information about the framework, we encourage you to join our slack channel. |
45 | 29 |
|
46 | | -[Slack](https://join.slack.com/t/investingbots/shared_invite/enQtODgwNTg3MzA2MjYyLTdiZjczZDRlNWJjNDdmYThiMGE0MzFhOTg4Y2E0NzQ2OTgxYjA1NzU3ZWJiY2JhOTE1ZGJlZGFiNDU3OTAzMDg) |
| 30 | +[join us on Slack](https://inv-algo-framework.slack.com) |
47 | 31 |
|
48 | 32 | ### [Bugs / Issues](https://github.com/investingbots/value-investing-bot/issues?q=is%3Aissue) |
49 | 33 |
|
50 | 34 | If you discover a bug in the bot, please |
51 | | -[search our issue tracker](https://github.com/investingbots/value-investing-bot/issues?q=is%3Aissue) |
| 35 | +[search our issue tracker](https://github.com/investing-algorithms/investing-algorithm-framework/issues?q=is%3Aissue) |
52 | 36 | first. If it hasn't been reported, please |
53 | | -[create a new issue](https://github.com/investingbots/value-investing-bot/issues/new) and |
54 | | -ensure you follow the template guide so that our team can assist you as |
55 | | -quickly as possible. |
56 | | - |
57 | | -### [Feature Requests](https://github.com/investingbots/value-investing-bot/labels/enhancement) |
58 | | - |
59 | | -Have you a great idea to improve the bot you want to share? Please, |
60 | | -first search if this feature was not [already discussed](https://github.com/investingbots/value-investing-bot/labels/enhancement). |
61 | | -If it hasn't been requested, please |
62 | | -[create a new request](https://github.com/investingbots/value-investing-bot/new) |
63 | | -and ensure you follow the template guide so that it does not get lost |
64 | | -in the bug reports. |
65 | | - |
66 | | -### [Pull Requests](https://github.com/investingbots/value-investing-bot/pulls) |
| 37 | +[create a new issue](https://github.com/investing-algorithms/investing-algorithm-framework/issues/new) and |
| 38 | +ensure you follow the template guide so that developers can assist you as quickly as possible. |
67 | 39 |
|
68 | | -Feel like our bot is missing a feature? We welcome your pull requests! |
| 40 | +Feel like the framework is missing a feature? We welcome your pull requests! |
69 | 41 |
|
70 | 42 | Please read our |
71 | | -[Contributing document](https://github.com/investingbots/value-investing-bot/blob/develop/CONTRIBUTING.md) |
| 43 | +[Contributing document](https://github.com/investing-algorithms/investing-algorithm-framework/blob/master/CONTRIBUTING.md) |
72 | 44 | to understand the requirements before sending your pull-requests. |
73 | 45 |
|
74 | | -**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](https://join.slack.com/t/investingbots/shared_invite/enQtODgwNTg3MzA2MjYyLTdiZjczZDRlNWJjNDdmYThiMGE0MzFhOTg4Y2E0NzQ2OTgxYjA1NzU3ZWJiY2JhOTE1ZGJlZGFiNDU3OTAzMDg). |
| 46 | +**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](https://join.slack.com/t/investingbots/shared_invite/enQtODgwNTg3MzA2MjYyLTdiZjczZDRlNWJjNDdmYThiMGE0MzFhOTg4Y2E0NzQ2OTgxYjA1NzU3ZWJiY2JhOTE1ZGJlZGFiNDU3OTAzMDg). |
75 | 47 | This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it. |
76 | 48 |
|
77 | | -**Important:** Always create your PR against the `develop` branch, not `master`. |
78 | | - |
79 | | -## Requirements |
80 | | - |
81 | | -### Uptodate clock |
82 | | -The clock must be accurate, syncronized to a NTP server very frequently to avoid problems with communication to the exchanges. |
83 | | - |
84 | | -### Min hardware required |
85 | | - |
86 | | -To run this bot we recommend you a cloud instance with a minimum of: |
87 | | - |
88 | | -- Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU |
89 | | - |
90 | | -In the future raspberry pi support will be added. |
91 | | - |
92 | | -### Software requirements |
93 | | - |
94 | | -- [Python 3.6.x](http://docs.python-guide.org/en/latest/starting/installation/) |
95 | | -- [pip](https://pip.pypa.io/en/stable/installing/) |
96 | | -- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) |
97 | | -- [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended) |
98 | | -- [Docker](https://www.docker.com/products/docker) (Recommended) |
| 49 | +**Important:** Always create your feature or hotfix against the `develop` branch, not `master`. |
0 commit comments