Metadata-Version: 2.4
Name: cadlag-quant
Version: 0.1.0a1
Summary: Command-line bundle for the Cadlag Mini educational backtesting 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
Requires-Dist: cadlag-sdk==0.1.0a1
Requires-Dist: cadlag-ce==0.1.0a1
Requires-Dist: cadlag-starter==0.1.0a1
Provides-Extra: analytics
Requires-Dist: cadlag-pro==0.1.0a1; extra == "analytics"
Dynamic: license-file

# cadlag-quant — 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.

Command-line bundle for the Cadlag Mini educational backtesting toolkit.

## Usage

```bash
pip install "cadlag-quant==0.1.0a1"
cadlag-mini
cadlag-mini --csv prices.csv --window 5 --cash 1000 --fee-bps 10
```

Optional basic analytics:

```bash
pip install "cadlag-quant[analytics]==0.1.0a1"
cadlag-mini --analytics
```

Input CSV must have exactly `date,close` columns, ISO dates in increasing order,
and finite positive prices. With no CSV, the command uses synthetic sample data.
Output is a JSON equity curve, trade count and total return. Values are illustrative
and depend on simplified execution assumptions; no live trading is performed.


## 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.
