Metadata-Version: 2.1
Name: quantflow
Version: 0.3.0
Summary: quantitative analysis
License: BSD-3-Clause
Author: Luca
Author-email: luca@quantmind.com
Requires-Python: >=3.11
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: cli
Provides-Extra: data
Requires-Dist: aio-fluid[http] (>=1.2.1,<2.0.0) ; extra == "data"
Requires-Dist: asciichartpy (>=1.5.25,<2.0.0) ; extra == "cli"
Requires-Dist: ccy (==1.6.0)
Requires-Dist: click (>=8.1.7,<9.0.0) ; extra == "cli"
Requires-Dist: polars[pandas,pyarrow] (>=1.11.0,<2.0.0)
Requires-Dist: prompt-toolkit (>=3.0.43,<4.0.0) ; extra == "cli"
Requires-Dist: pydantic (>=2.0.2,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: rich (>=13.9.4,<14.0.0) ; extra == "cli"
Requires-Dist: scipy (>=1.14.1,<2.0.0)
Project-URL: Documentation, https://quantmind.github.io/quantflow/
Project-URL: Homepage, https://github.com/quantmind/quantflow
Project-URL: Repository, https://github.com/quantmind/quantflow
Description-Content-Type: text/markdown

# <a href="https://quantmind.github.io/quantflow"><img src="https://raw.githubusercontent.com/quantmind/quantflow/main/notebooks/assets/quantflow-light.svg" width=300 /></a>

[![PyPI version](https://badge.fury.io/py/quantflow.svg)](https://badge.fury.io/py/quantflow)
[![Python versions](https://img.shields.io/pypi/pyversions/quantflow.svg)](https://pypi.org/project/quantflow)
[![Python downloads](https://img.shields.io/pypi/dd/quantflow.svg)](https://pypi.org/project/quantflow)
[![build](https://github.com/quantmind/quantflow/actions/workflows/build.yml/badge.svg)](https://github.com/quantmind/quantflow/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/quantmind/quantflow/branch/main/graph/badge.svg?token=wkH9lYKOWP)](https://codecov.io/gh/quantmind/quantflow)

Quantitative analysis and pricing tools.

Documentation is available as [quantflow jupyter book](https://quantmind.github.io/quantflow/).

## Installation

```bash
pip install quantflow
```

![btcvol](https://github.com/quantmind/quantflow/assets/144320/88ed85d1-c3c5-489c-ac07-21b036593214)


## Modules

* [quantflow.cli](https://github.com/quantmind/quantflow/tree/main/quantflow/cli) aommand line client (requires `quantflow[cli,data]`)
* [quantflow.data](https://github.com/quantmind/quantflow/tree/main/quantflow/data) data APIs (requires `quantflow[data]`)
* [quantflow.options](https://github.com/quantmind/quantflow/tree/main/quantflow/options) option pricing and calibration
* [quantflow.sp](https://github.com/quantmind/quantflow/tree/main/quantflow/sp) stochastic process primitives


## Command line tools

The command line tools are available when installing with the extra `cli` and `data` dependencies.

```bash
pip install quantflow[cli,data]
```

It is possible to use the command line tool `qf` to download data and run pricing and calibration scripts.

