Skip to content

Commit 8f61679

Browse files
committed
docs: add open-source README overview
1 parent 3afe478 commit 8f61679

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
# InteractiveBrokersPlatform
22

3+
<!-- qsl-doc-overview:start -->
4+
5+
> ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途。
6+
> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only.
7+
8+
## Open-source overview / 开源项目入口
9+
10+
| Item | Description |
11+
| --- | --- |
12+
| Project type | execution platform |
13+
| What it does | Interactive Brokers execution platform for QuantStrategyLab US/HK equity strategies with Cloud Run dispatch and dry-run controls. |
14+
| 中文说明 | IBKR 执行平台,负责加载策略、处理账户/市场输入,并通过 Cloud Run/调度执行 dry-run 或实盘路径。 |
15+
| Current status | Execution platform. Treat all live credentials, account IDs and order paths as production-sensitive. |
16+
17+
### Quick start
18+
19+
- `python -m pip install -e '.[test]'`
20+
- `python -m pytest -q`
21+
22+
### Deploy / operate safely
23+
24+
Start from dry-run GitHub Actions/Cloud Run deployment, verify secrets and account group config, then enable live execution only per account.
25+
26+
### Strategy performance / evidence boundary
27+
28+
Strategy performance is not owned here; review UsEquityStrategies, HkEquityStrategies and their snapshot pipeline evidence before enabling a profile.
29+
30+
> Detailed runbooks, migration notes, workflow internals, and historical decisions are kept below. Start with this overview before using the lower-level operational sections.
31+
32+
<!-- qsl-doc-overview:end -->
33+
334
> Risk warning: this project is not investment advice and is provided for study and engineering validation only.
435
536
![Python](https://img.shields.io/badge/Python-3.9%2B-blue)

0 commit comments

Comments
 (0)