Metadata-Version: 2.1
Name: vix_utils
Version: 0.1.0
Summary: Provide VIX Cash and Futures Term Structure as Pandas dataframes
Keywords: vix,volatility,pandas,vix term structure,cboe
Author-email: Doug Ransom <doug@ransom.vip>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Dist: pandas
Requires-Dist: pandas-market-calendars
Requires-Dist: aiofiles
Requires-Dist: aiohttp[speedups]
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: openpyxl
Requires-Dist: appdirs
Requires-Dist: matplotlib ; extra == "examples"
Requires-Dist: scipy ; extra == "examples"
Requires-Dist: pytest ; extra == "test"
Project-URL: home-page, https://github.com/dougransom/vix_utils
Provides-Extra: examples
Provides-Extra: test

# VIX Utils
## Overview

*vix_utils* provides some tools for preparing data for analysing  the VIX Futures and Cash Term structures.

VIX Futures Data downloaded from [CBOE Futures Historical Data](https://www.cboe.com/us/futures/market_statistics/historical_data/).

Vix Cash Data are downloaded from [CBOE Historical Volatility Indexes](https://www.cboe.com/tradable_products/vix/vix_historical_data/).


There is an API for Python to load the data into Pandas DataFrames.  If you do your analysis in Python, use the API.

Since there is no documentation yet, look at the examples in the src/vix_utils/examples folder.

If you do your analysis in other tools such as R or excel, you can use the command line tool vixutil.

`vixutil -h` will give the help.  The data are availble in record and wide formats.  Just run it and look at the excel or csv output to see what they look like.

## Coming Soon
30 day continuous maturity weighting of front two months of vix futures.

## Installation

You will need a Python 3.11 or later instalation.

### Install from the Python Packaging Index
 
Install using pip from [The Python Package Index ](https://www.pypi.org):

`pip install vix_utils`

If you want to run the samples, install like this:
`pip install vix_utils[examples]`

The sample to load all the various data frames can be run as:
'vix_sample_load_data'

The sample to plot the history of futures and cash term structures:
`vix_sample_plots`

When you run the samples, they will print out the Python script file names so you can find them wherever pip installs them.

### Development 

Clone from  [github repository](https://github.com/dougransom/vix_utils).

 
`pip install -e .[test,examples]` will:
- install vix_utils into your python environment, including any command line scripts. 
- install the necessary prequisites for running any 
tests in the `test` folder, and for running the programs in the `src/vixutils/examples` folder.

#### Testing

The tests directory contains a few tests.  This project wasn't developed with 
[Test Driven Development](https://www.agilealliance.org/glossary/tdd/), unit tests have been added to isolate
and fix defects. 

However, new features and bug fixes should be developed with [Test Driven Development](https://www.agilealliance.org/glossary/tdd/) practices when practical.


## Examples
Source is in `src/vix_utils/examples`
 
~~~
## Developing
https://numpydoc.readthedocs.io/en/latest/format.html

