Metadata-Version: 2.4
Name: eanalytics_api_py
Version: 0.1.50
Summary: Locally download a datamining dataset from the Eulerian Technologies API
Home-page: https://github.com/EulerianTechnologies/eanalytics-api-py
Download-URL: https://github.com/EulerianTechnologies/eanalytics-api-py/archive/master.zip
Author: Florian
Author-email: f.dauphin@eulerian.com
Keywords: eulerian,datamining,download,dw,data warehouse,eanalytics,jupyter,notebook,data science
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.23.0
Requires-Dist: ijson>=3.0.4
Requires-Dist: pandas>=1.0.3
Requires-Dist: ipython>=7.16.1
Requires-Dist: ipywidgets>=7.5.1
Requires-Dist: numpy>=1.19.1
Requires-Dist: pytest>=6.1.1
Requires-Dist: pathlib>=1.0.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# eanalytics_api_py

A python 3 module to retrieve data from Eulerian Technologies API

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

## Prerequisites

Having a python 3 environment

## Installing

```
pip3 install eanalytics_api_py
```

## Upgrading

```
pip3 install eanalytics_api_py --upgrade
```

## Running

See [sample notebooks](notebooks)

- [Eulerian datamining api doc](https://doc.api.eulerian.com/#tag/Datamining:-sales%2Fpaths%2F~1ea~1%7Bsite%7D~1report~1order~1download.json%2Fget) to customize your payload object: 
- [Eulerian Datawarehouse api doc](https://doc.api.eulerian.com/#section/EDW)

## Notes
- The file downloaded is gzipped
- Explore your data using jupyter-notebook along with pandas and seaborn for plug'n'play data cleaning/visualisation
- Samples jupyter notebooks featuring different use-cases will be uploaded in the near future
- A docker image containing jupyter and our librairy is available [here](https://hub.docker.com/repository/docker/soloan/eanalytics-jupyter/general)

## Author

* **Florian Dauphin** - https://github.com/Afilnor
