Skip to content

Commit d8e1034

Browse files
committed
Update gitignore
1 parent 8362da1 commit d8e1034

File tree

2 files changed

+19
-27
lines changed

2 files changed

+19
-27
lines changed

.vscode/settings.json

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,11 @@
1515

1616
# [Investing Algorithm Framework](https://github.com/coding-kitties/investing-algorithm-framework)
1717

18-
The Investing Algorithm Framework is a Python tool that enables swift and
19-
elegant development of trading bots. It comes with all the necessary
20-
components for creating algorithms, including data provisioning,
21-
portfolio management, and order execution.
18+
The Investing Algorithm Framework is a Python framework that enables swift and elegant development of trading bots. It comes with all the necessary components for creating trading strategies, including data management, portfolio, order, position and trades management.
2219

23-
Features:
20+
Features:
21+
22+
* Indicators module: A collection of indicators and utility functions that can be used in your trading strategies.
2423
* Order execution and tracking
2524
* Broker and exchange connections through [ccxt](https://github.com/ccxt/ccxt)
2625
* Backtesting and performance analysis reports [example](./examples/backtest_example)
@@ -32,12 +31,10 @@ Features:
3231
* Stateless running for cloud function deployments
3332
* Polars dataframes support out of the box for fast data processing [pola.rs](https://pola.rs/)
3433

35-
Additional features:
36-
* Indicators (python >= 3.10 required): Set of indicators that can be used in your trading bot. You can donwload the package with `pip install investing-algorithm-framework[indicators]` or `poetry add investing-algorithm-framework[indicators]]`
37-
3834
## Example implementation
39-
The following algorithm connects to binance and buys BTC every 5 seconds.
40-
It also exposes an REST API that allows you to interact with the algorithm.
35+
36+
The following algorithm connects to binance and buys BTC every 5 seconds. It also exposes an REST API that allows you to interact with the algorithm.
37+
4138
```python
4239
import pathlib
4340
from investing_algorithm_framework import create_app, PortfolioConfiguration, \
@@ -129,12 +126,13 @@ if __name__ == "__main__":
129126
> You can find more examples [here](./examples) folder.
130127
131128
## Backtesting and experiments
132-
The framework also supports backtesting and performing backtest experiments. After
133-
a backtest, you can print a report that shows the performance of your trading bot.
129+
130+
The framework also supports backtesting and performing backtest experiments. After a backtest, you can print a report that shows the performance of your trading bot.
134131

135132
To run a single backtest you can use the example code that can be found [here](./examples/backtest).
136133

137134
### Backtesting report
135+
138136
You can use the ```pretty_print_backtest``` function to print a backtest report.
139137
For example if you run the [moving average example trading bot](./examples/crossover_moving_average_trading_bot)
140138
you will get the following backtesting report:
@@ -221,13 +219,15 @@ Trades overview
221219
```
222220

223221
### Backtest experiments
222+
224223
The framework also supports backtest experiments. Backtest experiments allows you to
225224
compare multiple algorithms and evaluate their performance. Ideally,
226225
you would do this by parameterizing your strategy and creating a factory function that
227226
creates the algorithm with the different parameters. You can find an example of this
228227
in the [backtest experiments example](./examples/backtest_experiment).
229228

230229
## Broker/Exchange configuration
230+
231231
The framework has by default support for [ccxt](https://github.com/ccxt/ccxt).
232232
This should allow you to connect to a lot of brokers/exchanges.
233233

@@ -253,17 +253,20 @@ app.add_portfolio_configuration(
253253
```
254254

255255
## Performance
256+
256257
We are continuously working on improving the performance of the framework. If
257258
you have any suggestions, please let us know.
258259

259260
## Download
261+
260262
You can download the framework with pypi.
261263

262264
```bash
263265
pip install investing-algorithm-framework
264266
```
265267

266268
## Disclaimer
269+
267270
If you use this framework for your investments, do not risk money
268271
which you are afraid to lose, until you have clear understanding how
269272
the framework works. We can't stress this enough:
@@ -288,8 +291,8 @@ If you'd like to chat with investing-algorithm-framework users
288291
and developers, [join us on Slack](https://inv-algo-framework.slack.com) or [join us on reddit](https://www.reddit.com/r/InvestingBots/)
289292

290293
## Acknowledgements
291-
We want to thank all contributors to this project. A full list of all
292-
the people that contributed to the project can be
294+
295+
We want to thank all contributors to this project. A full list of all the people that contributed to the project can be
293296
found [here](https://github.com/investing-algorithms/investing-algorithm-framework/blob/master/AUTHORS.md)
294297

295298
### [Bugs / Issues](https://github.com/investing-algorithms/investing-algorithm-framework/issues?q=is%3Aissue)
@@ -298,9 +301,9 @@ If you discover a bug in the framework, please [search our issue tracker](https:
298301
first. If it hasn't been reported, please [create a new issue](https://github.com/investing-algorithms/investing-algorithm-framework/issues/new).
299302

300303
### Contributing
304+
301305
The investing algorithm framework is a community driven project.
302-
We welcome you to participate, contribute and together help build
303-
the future trading bots developed in python.
306+
We welcome you to participate, contribute and together help build the future trading bots developed in python.
304307

305308
Feel like the framework is missing a feature? We welcome your pull requests!
306309
If you want to contribute to the project roadmap, please take a look at the [project board](https://github.com/coding-kitties/investing-algorithm-framework/projects?query=is%3Aopen).

0 commit comments

Comments
 (0)