Metadata-Version: 2.4
Name: pairlink
Version: 0.0.1
Summary: A package for statistical analysis and testing of relationships between 2 time series.
Home-page: https://www.developexx.com
Author: Anthony Gocmen
Author-email: anthony.gocmen@gmail.com
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: statsmodels
Requires-Dist: scipy
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# PairLink

## Description

`PairLink` is a diagnostic tool designed to evaluate the statistical relationship between two time series. 

It provides an assessment of their stationarity, cointegration, distributional characteristics, and mean-reverting behavior.

## Installation

You can install `PairLink` via pip:

```bash
pip install pairlink
```

## Usage
Here is a simple example to identify frequent price levels from your price data:
```python
import yfinance as yf
from pairlink import preprocess_series, pairlink_test

df = yf.download(tickers=['AAPL','MSFT'], interval='1D')

y, x = preprocess_series(series1=df['Close']['AAPL'], series2=df['Close']['MSFT'])
results = pairlink_test(y,x)
```

## Author

Anthony Gocmen - [email](mailto:anthony.gocmen@gmail.com)  
WebSite: [developexx](https://www.developexx.com)


## License


This project is licensed under the MIT License - see [MIT](https://choosealicense.com/licenses/mit/) for details.
