Metadata-Version: 2.1
Name: hmile
Version: 0.5.1
Summary: Python 3.x module to render financial results in tensorboard 
Home-page: https://github.com/theophane-droid/8miles-render
Author: theophanedroid
Author-email: theodesile@gmail.com
License: MIT license
Project-URL: Bug Tracker, https://github.com/theophane-droid/8miles-render/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: ta (>=0.10.2)
Requires-Dist: pandas (~=1.5.3)
Requires-Dist: elasticsearch (>=8.6.2)
Requires-Dist: numpy (>=1.24.2)
Requires-Dist: yfinance (>=0.1.74)
Requires-Dist: ta-lib (>=0.4.25)
Requires-Dist: pandas-ta (>=0.3.14b0)
Requires-Dist: requests (>=2.28.1)
Requires-Dist: pyyaml (>=6.0)
Requires-Dist: scipy (>=1.10.1)
Provides-Extra: test
Requires-Dist: unittest2 ; extra == 'test'

# 8 MILE

[![Test](https://github.com/theophane-droid/8mile/actions/workflows/python_test.yml/badge.svg)](https://github.com/theophane-droid/8mile/actions/workflows/python_test.yml/badge.svg) [![Documentation](https://readthedocs.org/projects/8mile/badge/?version=latest)](https://8mile.readthedocs.io/en/latest/?badge=latest)

Python 3.x module to treat financial data for machine learning purpose. Many features including :
* download financial data from various sources
* preprocess data
* export data

![](img/8mile.jpg)

## 🔥 Installation

Pre-requisites:
- python3
- pip3

Install the talib library:

```bash
wget http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
tar -xzf ta-lib-0.4.0-src.tar.gz
cd ta-lib/ && ./configure --prefix=/usr && make && make install
```

Install the package with pip3

```bash
pip3 install hmile
```

## 📚 Documentation

[Find doc here](https://8mile.readthedocs.io/en/latest)

## 🛠️ Build doc

You can rebuild the doc with the following commands:

```bash
make html
rm -r docs
mv _build/html docs
rm -rf _build
```
