Metadata-Version: 2.1
Name: npd-category-correlation
Version: 0.1.5
Summary: Library for calculating NPD Category Correlations with Financial Data
Home-page: https://NPDGroup@dev.azure.com/NPDGroup/NPDFinancialServices/_git/NPDCategoryCorrelation
Author: Max Leonard
Author-email: maxhleonard@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# Introduction 
This package has been created for the purpose of integrating Bloomberg Data with NPD Equity Watch data.

# Installation
IMPORTANT: you must separately install the Bloomberg Python API before using certain functions (first line below)
```bash
python -m pip install --index-url=https://bcms.bloomberg.com/pip/simple blpapi

python -m pip install npd-category-correlation==0.1.3
```

# Use Case: Creating Category Correlation Dataset
The get-correlation-dataset command takes two parameters: the path to your local EW flat file (must be CSV readable) and your desired output path (if left blank will be directory in which you run the command)

```bash
get-correlation-dataset path/to/FlatFile/EW_DATA.gz path/to/output/correlation_data.csv
``` 

IMPORTANT: You must login have Bloomberg Anywhere Terminal running on your computer for this to work.




