Metadata-Version: 2.1
Name: time-series-predictor
Version: 1.3.5
Summary: Time Series Predictor
Home-page: https://timeseriespredictor.readthedocs.io/
Author: Daniel Kaminski de Souza
Author-email: daniel@kryptonunite.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6<3.8
Description-Content-Type: text/markdown
Requires-Dist: torch
Requires-Dist: skorch
Requires-Dist: scipy
Requires-Dist: psutil
Provides-Extra: dev
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: autopep8 ; extra == 'dev'
Requires-Dist: bumpversion ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: python-dotenv ; extra == 'dev'
Requires-Dist: python-dotenv[cli] ; extra == 'dev'
Requires-Dist: lxml ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: rstcheck ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: recommonmark ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: pandas ; extra == 'docs'
Requires-Dist: seaborn ; extra == 'docs'
Requires-Dist: sklearn ; extra == 'docs'
Requires-Dist: jupyterlab ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: python-dotenv ; extra == 'docs'
Requires-Dist: lxml ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest (>=4.6) ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pandas ; extra == 'test'
Requires-Dist: seaborn ; extra == 'test'
Requires-Dist: sklearn ; extra == 'test'
Requires-Dist: python-dotenv ; extra == 'test'
Requires-Dist: lxml ; extra == 'test'
Requires-Dist: requests ; extra == 'test'

# Time Series Predictor

[![PyPI version](https://badge.fury.io/py/time-series-predictor.svg)](https://badge.fury.io/py/time-series-predictor) [![Documentation Status](https://readthedocs.org/projects/time-series-predictor/badge/?version=latest)](https://time-series-predictor.readthedocs.io/en/latest/?badge=latest) [![travis](https://travis-ci.org/krypton-unite/time_series_predictor.svg?branch=master)](https://travis-ci.org/github/krypton-unite/time_series_predictor) [![codecov](https://codecov.io/gh/krypton-unite/time_series_predictor/branch/master/graph/badge.svg)](https://codecov.io/gh/krypton-unite/time_series_predictor) [![Requirements Status](https://requires.io/github/krypton-unite/time_series_predictor/requirements.svg?branch=master)](https://requires.io/github/krypton-unite/time_series_predictor/requirements/?branch=master) [![GitHub license](https://img.shields.io/github/license/krypton-unite/time_series_predictor)](https://github.com/krypton-unite/time_series_predictor)

## Usage

Please refer to the following examples:

- [example_flights_dataset.ipynb](https://time-series-predictor.readthedocs.io/en/latest/notebooks/example_flights_dataset.html)
- [example_oze_challenge.ipynb](https://time-series-predictor.readthedocs.io/en/latest/notebooks/example_oze_challenge.html)

## Pre requisistes installation

### Windows

```powershell
python -m venv .\.env
.\.env\Scripts\activate
pip install pip-tools
python setup.py synchronize
```

#### Linux or MacOS

```bash
python -m venv .env
. .env/bin/activate
pip install pip-tools
python setup.py synchronize
```

--------

## Development

```terminal
pip install -e .[dev]
```

--------

## Test

```terminal
pip install -e .[test]
pytest -s
```

--------

## Build docs

```terminal
pip install -e .[docs]
# cd docs
# make html
sphinx-build docs/source docs/build
```


