Metadata-Version: 2.4
Name: quant-limit-probability-cli
Version: 0.1.1
Summary: 次日涨跌停概率：本地回填、训练、发布、上传 CLI（无需完整 Engine 服务）
Author: Quant Copilot
Project-URL: Homepage, https://github.com/MaelWeb/quant-copilot
Project-URL: Documentation, https://github.com/MaelWeb/quant-copilot/blob/main/docs/plans/next-session-limit-probability.md
Project-URL: Repository, https://github.com/MaelWeb/quant-copilot
Project-URL: Issues, https://github.com/MaelWeb/quant-copilot/issues
Keywords: quant,limit-up,lightgbm,a-share
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.24
Requires-Dist: pandas>=2.0.0
Requires-Dist: scikit-learn>=1.4.0
Requires-Dist: lightgbm>=4.0.0
Provides-Extra: backfill
Requires-Dist: akshare; extra == "backfill"
Provides-Extra: parquet
Requires-Dist: pyarrow>=14.0; extra == "parquet"
Provides-Extra: all
Requires-Dist: akshare; extra == "all"
Requires-Dist: pyarrow>=14.0; extra == "all"

# quant-limit-probability-cli

次日涨跌停概率**本地工作站** CLI：回填、构建训练集、训练、离线推理、本地发布/回滚、经 Engine API 上传。

与完整 `engine` 服务解耦：安装本包即可在笔记本上跑训练流水线；线上推理仍由 Engine + `LIMIT_PROBABILITY_ARTIFACT_DIR` 承担。

## 从 PyPI 安装（推荐）

```bash
python -m venv ~/.venvs/quant-limit-cli
source ~/.venvs/quant-limit-cli/bin/activate   # Windows: Scripts\activate
pip install -U pip

# 核心：build / train / predict / deploy / rollback / upload
pip install quant-limit-probability-cli

# 含历史 K 线 / 涨跌停池回填 + Parquet
pip install "quant-limit-probability-cli[all]"
```

安装后在**已激活的 venv**（或把 venv 的 `bin` 加入 `PATH`）的任意终端运行：

```bash
quant-limit-probability --help
quant-limit-probability-backfill --help
```

`upload` 需环境变量：`ENGINE_API_URL`、`ENGINE_SHARED_SECRET`。

## 从源码安装（开发 / 未发布版本）

```bash
cd engine
pip install -e ".[all]"
```

## 命令

安装后提供两个控制台命令（与 `python -m scripts.*` 等价）：

| 命令 | 作用 |
|---|---|
| `quant-limit-probability` | `build` · `train` · `predict` · `deploy` · `rollback` · `upload` |
| `quant-limit-probability-backfill` | `klines` · `limit-pools` |

示例：

```bash
quant-limit-probability train --input dataset.parquet --output-dir ./artifacts
quant-limit-probability upload --source-dir ./artifacts/limit_probability_<version>
```

环境变量（`upload`）：`ENGINE_API_URL`、`ENGINE_SHARED_SECRET`。

详细流水线见仓库 `docs/plans/next-session-limit-probability.md`。

## 维护者：发布到 PyPI

1.  bump `engine/pyproject.toml` 的 `version`。
2.  本地自检：`cd engine && ./scripts/verify_cli_package_build.sh`
3.  提交并推送 tag（须与 version 一致）：
    ```bash
    git tag quant-limit-probability-cli-v0.1.1
    git push origin quant-limit-probability-cli-v0.1.1
    ```
4.  GitHub Actions **Publish quant-limit-probability-cli** 会使用 `PYPI_API_TOKEN` 上传。

仓库 Secrets：`PYPI_API_TOKEN`（必填）；`TESTPYPI_API_TOKEN`（可选，手动 workflow 选 testpypi）。

首次在 [pypi.org](https://pypi.org/) 注册并创建 API token（scope: 整个账户或项目 `quant-limit-probability-cli`）。
