Metadata-Version: 2.4
Name: cadlag-pro
Version: 0.1.0a1
Summary: Basic drawdown and volatility statistics for the Cadlag Mini educational toolkit
Author: Cadlag contributors
License-Expression: MIT
Project-URL: Homepage, https://cadlag.pro
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# cadlag-pro — Cadlag Mini

**Version 0.1.0a1 is an educational miniature written independently from scratch.**
It provides the small functionality described below. It does not provide the full
Cadlag platform and is not API-compatible with previous Cadlag distributions.
It is an alpha release for learning and experimentation, not live trading.

Basic drawdown and volatility statistics for the Cadlag Mini educational toolkit.

## Usage

```python
from cadlag_pro import max_drawdown, annualized_volatility
print(max_drawdown([100, 120, 90, 110]))  # 0.25
print(annualized_volatility([100, 110, 99], periods_per_year=2))  # about 0.2
```

Drawdown is a nonnegative fraction. Volatility uses the sample standard deviation
of simple returns and square-root annualization. Inputs must be positive and
finite, with evenly spaced observations for annualization. Fewer than two returns
produce zero volatility. The Mini edition contains only these basic statistics;
it does not include commercial platform features or a licensing system.


## Package family

- `cadlag-sdk`: price records and CSV validation.
- `cadlag-ce`: a prior-close moving-average strategy and equity curve.
- `cadlag-starter`: synthetic sample prices and a runnable example.
- `cadlag-pro`: basic drawdown and volatility calculations.
- `cadlag-quant`: command-line bundle, with optional analytics extra.

All Mini components use version `0.1.0a1` and are MIT licensed. Only Python's
standard library is used beyond dependencies on other Mini components.
