Skip to content

docs: publish strategy entrypoint release line #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pigbibi merged 1 commit into from
Apr 6, 2026
Merged

docs: publish strategy entrypoint release line #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ Standalone `us_equity` strategy repository for QuantStrategyLab platforms.

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.

### Contract boundary

The current integration path is:

- live profiles expose manifest-backed unified entrypoints
- downstream platforms load those entrypoints through `QuantPlatformKit`
- strategy outputs stay inside the shared `StrategyDecision` contract
- broker-specific execution order, UI rows, and notification layout stay in platform repositories

Legacy strategy functions may still exist as internal adapters, but downstream runtimes should treat `entrypoints/` and manifests as the supported integration surface.

### Strategy index

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

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

### 契约边界

当前主线集成方式已经固定为：

- live profile 暴露 manifest 驱动的统一 entrypoint
- 下游平台通过 `QuantPlatformKit` 加载这些 entrypoint
- 策略输出保持在共享 `StrategyDecision` 契约内
- 券商专属执行顺序、UI 展示行和通知布局继续留在平台仓库

旧策略函数可以继续作为仓库内部 adapter 存在，但下游运行时应把 `entrypoints/` 和 manifest 当成正式接入面。

### 策略索引

| Canonical profile | 显示名 | 当前下游运行仓库 | 核心思路 |
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"

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

[tool.setuptools]
Expand Down