Skip to content

Commit ff3accc

Browse files
committed
docs: publish strategy entrypoint release line
1 parent 84da76d commit ff3accc

2 files changed

Lines changed: 24 additions & 2 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ Standalone `us_equity` strategy repository for QuantStrategyLab platforms.
1111

1212
This repository is the strategy layer: it owns pure signal, allocation, and target-computation logic plus strategy metadata. Downstream platform repositories still own broker adapters, order routing, schedule, secrets, and notifications.
1313

14+
### Contract boundary
15+
16+
The current integration path is:
17+
18+
- live profiles expose manifest-backed unified entrypoints
19+
- downstream platforms load those entrypoints through `QuantPlatformKit`
20+
- strategy outputs stay inside the shared `StrategyDecision` contract
21+
- broker-specific execution order, UI rows, and notification layout stay in platform repositories
22+
23+
Legacy strategy functions may still exist as internal adapters, but downstream runtimes should treat `entrypoints/` and manifests as the supported integration surface.
24+
1425
### Strategy index
1526

1627
| Canonical profile | Display name | Compatible platforms | Cadence | Benchmark | Role | Status |
@@ -273,6 +284,17 @@ PYTHONPATH=src:. python3 scripts/backtest_russell_1000_multi_factor_defensive.py
273284

274285
这个仓库负责**纯策略层**:信号、仓位、目标权重计算,以及策略元数据。下游平台仓库继续负责券商适配、下单方式、调度、密钥和通知。
275286

287+
### 契约边界
288+
289+
当前主线集成方式已经固定为:
290+
291+
- live profile 暴露 manifest 驱动的统一 entrypoint
292+
- 下游平台通过 `QuantPlatformKit` 加载这些 entrypoint
293+
- 策略输出保持在共享 `StrategyDecision` 契约内
294+
- 券商专属执行顺序、UI 展示行和通知布局继续留在平台仓库
295+
296+
旧策略函数可以继续作为仓库内部 adapter 存在,但下游运行时应把 `entrypoints/` 和 manifest 当成正式接入面。
297+
276298
### 策略索引
277299

278300
| Canonical profile | 显示名 | 当前下游运行仓库 | 核心思路 |

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "us-equity-strategies"
7-
version = "0.6.0"
7+
version = "0.7.0"
88
description = "Shared US equity strategy catalog and implementations"
99
readme = "README.md"
1010
requires-python = ">=3.11"
1111
dependencies = [
12-
"quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@5174d9e40f79fffae47450a42e26434145d28b31",
12+
"quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@v0.7.0",
1313
]
1414

1515
[tool.setuptools]

0 commit comments

Comments
 (0)