Metadata-Version: 2.1
Name: finterion-investing-algorithm-framework
Version: 0.12
Summary: Official Finterion plugin for the investing algorithm framework
Home-page: https://github.com/finterion/finterion-investing-algorithm-framework.git
Author: Finterion
License: Apache License 2.0
Keywords: Finterion,finterion,investing-algorithm,investing-algorithm-framework,INVESTING,BOT,ALGORITHM,FRAMEWORK,investing-bots,trading-bots
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: investing-algorithm-framework >=2.0.4
Requires-Dist: finterion >=0.7.4

# Finterion Investing Algorithm Framework Plugin
This is the official plugin for the [investing algorithm framework](https://investing-algorithm-framework.com) open source project.

## Installation
You can install the plugin with pip.
```shell
pip install finterion-investing-algorithm-framework
```

## Usage 
In order to use the plugin you must use the 'create_app' function provided 
by the plugin. This function will return an instance of the investing 
algorithm framework configured with the finterion platform.

> **Note:** You must provide the API key of your algorithm in order to use 
> the plugin. You can find your API keys in the developer dashboard of
> your algorithm on the finterion platform.

```python
from finterion_investing_algorithm_framework import create_app

app = create_app(api_key="<YOUR_TRADING_BOT_FINTERION_API_KEY>")

# Add your investing algorithm framework market data sources
# ..... 

# Add your investing algorithm framework trading strategies
# ....

if __name__ == "__main__":
    app.run()
```

## Documentation
You can find the official documentation at our [documentation website](https://docs.finterion.com/)
