Skip to content

Commit 47864a8

Browse files
committed
Add bilingual README sections
1 parent 3dffc0f commit 47864a8

1 file changed

Lines changed: 85 additions & 1 deletion

File tree

README.md

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

33
Shared broker adapters, domain models, execution ports, and notification utilities for QuantStrategyLab strategies.
44

5-
[中文说明](./README.zh-CN.md)
5+
[English](#english) | [中文](#中文) | [中文详版](./README.zh-CN.md)
6+
7+
---
8+
9+
<a id="english"></a>
10+
## English
611

712
## Scope
813

@@ -77,3 +82,82 @@ Cloud Run and self-hosted runner deployments should continue to deploy the strat
7782
- fixed-tag dependency rules
7883
- Google Cloud trigger rebind steps after repo rename
7984
- HK / SG multi-service guidance for `LongBridgeQuant`
85+
86+
---
87+
88+
<a id="中文"></a>
89+
## 中文
90+
91+
`QuantPlatformKit``QuantStrategyLab` 的共享平台层仓库。
92+
93+
它负责放这些内容:
94+
95+
- 统一领域模型
96+
- 市场数据、持仓、执行、通知相关的公共接口
97+
- IBKR / Schwab / LongBridge / Binance 的平台适配层
98+
- 少量可复用的通知和运行时工具
99+
100+
它不负责放这些内容:
101+
102+
- 具体策略规则
103+
- 目标仓位和调仓计算
104+
- Cloud Run 或 VPS 入口
105+
- 某一个平台仓库自己的调度和部署编排
106+
107+
### 范围
108+
109+
这个仓库是各平台仓库共享的公共依赖。
110+
111+
### 目录结构
112+
113+
```text
114+
src/quant_platform_kit/
115+
common/
116+
models.py
117+
ports.py
118+
strategies.py
119+
ibkr/
120+
connection.py
121+
market_data.py
122+
portfolio.py
123+
execution.py
124+
binance/
125+
client.py
126+
account.py
127+
market_data.py
128+
execution.py
129+
schwab/
130+
auth.py
131+
market_data.py
132+
portfolio.py
133+
execution.py
134+
longbridge/
135+
auth.py
136+
market_data.py
137+
portfolio.py
138+
execution.py
139+
notifications/
140+
telegram.py
141+
tests/
142+
```
143+
144+
### 开发
145+
146+
运行测试:
147+
148+
```bash
149+
PYTHONPATH=src python3 -m unittest discover -s tests
150+
```
151+
152+
### 发布和部署
153+
154+
`QuantPlatformKit` 只作为共享依赖,不单独部署。策略仓库应该固定依赖某个 Git tag,例如:
155+
156+
```text
157+
quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@v0.6.0
158+
```
159+
160+
部署说明见:
161+
162+
- [英文部署说明](./docs/deployment_model.md)
163+
- [中文部署说明](./docs/deployment_model.zh-CN.md)

0 commit comments

Comments
 (0)