# qteasy-xtquant

**Repository Path**: jackie-peng/qteasy-xtquant

## Basic Information

- **Project Name**: qteasy-xtquant
- **Description**: qteasy的官方QMT实盘交易扩展
- **Primary Language**: Python
- **License**: BSD-3-Clause
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-17
- **Last Updated**: 2026-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# qteasy-xtquant

**XtQuant / MiniQMT** optional extension for [qteasy](https://github.com/shepherdpp/qteasy) live trading.

> **Status (2026-05): coordination placeholder — not ready for live trading.**  
> This repository holds collaboration timelines and a minimal package skeleton.  
> **Do not expect `pip install` from PyPI** until **v0.1** after Windows Spike sign-off.

---

## For users

1. Use **qteasy >= 2.5.2** for upstream broker contract support (`5-tuple`, `live_trade_broker_type='xtquant'` whitelist).
2. **Broker Adapter Contract v1** (canonical, English):  
   https://qteasy.readthedocs.io/en/latest/live_trading/4a-xtquant-broker-adapter-contract-v1.html
3. Calling `qteasy_xtquant.register()` in this placeholder raises `NotImplementedError` by design.

```python
import qteasy_xtquant
qteasy_xtquant.register()  # NotImplementedError until v0.1
```

---

## For contributors（协作方）

协作阶段时间表、Spike 勾选清单、决策记录见 **`docs/collaboration/`**（中文为主，可整目录给 AI 作上下文）。

| 文档 | 读者 |
|------|------|
| [docs/collaboration/02-contributor-worklist.md](docs/collaboration/02-contributor-worklist.md) | helloeveroneday（个人贡献者） |
| [docs/collaboration/decision-log.md](docs/collaboration/decision-log.md) | 轨道与时间线 |
| [docs/collaboration/MiniQMT-Spike-checklist.md](docs/collaboration/MiniQMT-Spike-checklist.md) | S0-5 Spike 验收 |

**当前节奏**：Scenario 1；贡献方先收敛本地 P0，Spike 延后约 2～3 周；**无 v0.1 交付压力**。

---

## License

BSD 3-Clause — see [LICENSE](LICENSE).

Contributions require **Signed-off-by** (DCO) and BSD 3-Clause compatibility.