Skip to content

Commit 0cd5085

Browse files
committed
Refactor README.rst
1 parent 23b3aab commit 0cd5085

File tree

3 files changed

+281
-259
lines changed

3 files changed

+281
-259
lines changed

README.rst

+16-259
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
StrategyEase-Python-SDK
2-
==================
2+
=======================
33

44
策略易(StrategyEase)Python SDK。
55

@@ -21,13 +21,18 @@ StrategyEase-Python-SDK
2121
--------
2222

2323
- 简单的策略易 HTTP API 封装,见 strategyease_sdk/client.py
24-
- 多账号自动新股申购(自动打新)
25-
- 多账号自动逆回购
26-
- 定时批量下单
27-
- 聚宽(JoinQuant)集成
28-
- `米筐(RiceQuant)`_ 集成
29-
- 优矿(Uqer)集成
30-
- `果仁(Guorn)集成 <#果仁guorn集成>`__
24+
- 定时任务
25+
26+
- 多账号自动新股申购(自动打新)
27+
- 多账号自动逆回购
28+
- 定时批量下单
29+
30+
- 策略集成
31+
32+
- 聚宽(JoinQuant)集成
33+
- 米筐(RiceQuant)集成
34+
- 优矿(Uqer)集成
35+
- 果仁(Guorn)集成
3136

3237
基本用法
3338
--------------
@@ -63,255 +68,11 @@ StrategyEase-Python-SDK
6368

6469
定时任务调度
6570
--------------
71+
见《`定时任务调度说明 <docs/scheduler.rst>`_》
6672

67-
- 多账号自动申购新股(自动打新)
68-
- 多账号自动申购转债
69-
- 多账号自动逆回购
70-
- 定时批量下单
71-
- 聚宽(JoinQuant)
72-
- 自动跟单模拟交易(抓取方式)
73-
- 自动同步擂台策略(抓取方式)
74-
- `米筐(RiceQuant)`_ 自动跟单(抓取方式)
75-
- 优矿(Uqer)自动跟单(抓取方式)
76-
77-
Windows
78-
~~~~~~~
79-
80-
安装
81-
^^^^
82-
83-
- 安装 Python 3.5(建议安装 `Anaconda3-4.2.0 <https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/>`_)
84-
- cmd 中运行
85-
86-
+--------+-------------------------------------------------------------------------+
87-
| 正式版 | :code:`pip install --no-binary strategyease_sdk strategyease_sdk` |
88-
+--------+-------------------------------------------------------------------------+
89-
| 测试版 | :code:`pip install --pre --no-binary strategyease_sdk strategyease_sdk` |
90-
+--------+-------------------------------------------------------------------------+
91-
92-
配置
93-
^^^^
94-
95-
- cmd 中运行::code:`explorer %UserProfile%\.strategyease_sdk\config`
96-
- 修改 scheduler.ini 中的配置(建议使用Notepad++)
97-
98-
运行
99-
^^^^
100-
101-
- cmd 下运行::code:`strategyease-scheduler`
102-
103-
升级
104-
^^^^
105-
106-
- cmd 中运行
107-
108-
+--------+---------------------------------------------------------------------------------------------+
109-
| 正式版 | :code:`pip install --upgrade --no-deps --no-binary strategyease_sdk strategyease_sdk` |
110-
+--------+---------------------------------------------------------------------------------------------+
111-
| 测试版 | :code:`pip install --upgrade --pre --no-deps --no-binary strategyease_sdk strategyease_sdk` |
112-
+--------+---------------------------------------------------------------------------------------------+
113-
114-
- 参考 scheduler-template.ini 修改 scheduler.ini
115-
116-
日志
117-
^^^^
118-
119-
- cmd 中运行::code:`explorer %UserProfile%\AppData\Local\爱股网\策略易`
120-
121-
Mac/Linux
122-
~~~~~~~~~
123-
124-
安装
125-
^^^^
126-
127-
- 安装 Python 3.5
128-
- terminal 中运行
129-
130-
+--------+-------------------------------------------------------------------------+
131-
| 正式版 | :code:`pip install --no-binary strategyease_sdk strategyease_sdk` |
132-
+--------+-------------------------------------------------------------------------+
133-
| 测试版 | :code:`pip install --pre --no-binary strategyease_sdk strategyease_sdk` |
134-
+--------+-------------------------------------------------------------------------+
135-
136-
配置
137-
^^^^
138-
139-
- 修改 ~/.strategyease_sdk/config/scheduler.ini
140-
141-
运行
142-
^^^^
143-
144-
- terminal 中运行::code:`strategyease-scheduler:code:`
145-
146-
升级
147-
^^^^
148-
149-
- terminal 中运行
150-
151-
+--------+---------------------------------------------------------------------------------------------+
152-
| 正式版 | :code:`pip install --upgrade --no-deps --no-binary strategyease_sdk strategyease_sdk` |
153-
+--------+---------------------------------------------------------------------------------------------+
154-
| 测试版 | :code:`pip install --upgrade --pre --no-deps --no-binary strategyease_sdk strategyease_sdk` |
155-
+--------+---------------------------------------------------------------------------------------------+
156-
157-
- 参考 scheduler-template.ini 修改 scheduler.ini
158-
159-
聚宽(JoinQuant)集成
160-
---------------------
161-
162-
一. 推送方式
163-
~~~~~~~~~~~~
164-
165-
适用于云服务器环境,例如阿里云;特点是稳定、高效,集成简单。
166-
167-
准备工作
168-
^^^^^^^^
169-
170-
- 部署策略易。
171-
- 本地测试通过。
172-
- 远程测试通过。
173-
174-
步骤
175-
^^^^
176-
177-
- 下载 `scripts/strategyease_sdk_installer.ipynb`_ 并上传至“投资研究”根目录。
178-
- 打开该文件,设置参数:QUANT_NAME = 'joinquant'
179-
- 查看其它参数并根据需要进行修改。
180-
- 点击工具栏中的右箭头运行该文件,并检查窗口中打印的日志。
181-
- 修改 strategyease_sdk_config.yaml,升级后需参考 strategyease_sdk_config_template.yaml 进行修改。
182-
- 修改策略代码,可参考如下示例:
183-
184-
- examples/joinquant/simple\_strategy.py - 基本跟单用法(侵入式设计,不推荐)
185-
- examples/joinquant/advanced\_strategy.py - 高级同步、跟单用法(非侵入式设计,推荐)
186-
- examples/joinquant/new\_stocks\_purchase.py - 新股申购
187-
- examples/joinquant/convertible\_bonds\_purchase.py - 转债申购
188-
- examples/joinquant/repo.py - 逆回购
189-
190-
同步操作注意事项:
191-
192-
- 同步操作根据模拟盘持仓比例对实盘进行调整。
193-
- 同步操作依赖于“可用”资金。请留意配置文件中“撤销全部订单”相关选项。
194-
- “新股申购”不影响“可用”资金,并且不可被撤销,因此不影响同步功能。
195-
- 同步操作依赖于策略易 API /adjustments;因此也依赖于“查询投资组合”API,使用前请先做好测试及配置。
196-
- 同步操作使用“市价单”。
197-
- 如遇到策略报错“ImportError: No module named strategyease_sdk”,请稍后重试。
198-
- 量化平台模拟交易运行中升级 SDK,需重启生效。
199-
200-
二. 抓取方式
201-
~~~~~~~~~~~~
202-
203-
无需云服务器,采用定时轮询的方式,实时性不如"推送方式"。
204-
205-
准备工作
206-
^^^^^^^^
207-
208-
- 部署策略易。
209-
- 测试通过。
210-
211-
步骤
212-
^^^^
213-
214-
见 `定时任务调度 <#定时任务调度>`__
215-
216-
米筐(RiceQuant)集成
217-
---------------------
218-
219-
一. 推送方式
220-
~~~~~~~~~~~~
221-
222-
适用于云服务器环境,例如阿里云;特点是稳定、高效,集成简单。
223-
224-
准备工作
225-
^^^^^^^^
226-
227-
- 部署策略易。
228-
- 本地测试通过。
229-
- 远程测试通过。
230-
231-
步骤
232-
^^^^
233-
234-
- 下载 `scripts/strategyease_sdk_installer.ipynb`_ 并上传至“策略研究”根目录。
235-
- 打开该文件,设置参数:QUANT_NAME = 'ricequant'
236-
- 查看其它参数并根据需要进行修改。
237-
- 点击工具栏中的右箭头运行该文件,并检查窗口中打印的日志。
238-
- 修改策略代码,可参考如下示例:
239-
240-
- examples/ricequant/simple\_strategy.py - 基本用法
241-
- examples/ricequant/advanced\_strategy.py - 高级同步用法(非侵入式设计,推荐)
242-
- examples/ricequant/new\_stocks\_purchase.py - 新股申购
243-
- examples/ricequant/convertible\_bonds\_purchase.py - 转债申购
244-
- examples/ricequant/repo.py - 逆回购
245-
246-
二. 抓取方式
247-
~~~~~~~~~~~~
248-
249-
采用定时轮询的方式。
250-
251-
准备工作
252-
^^^^^^^^
253-
254-
- 部署策略易。
255-
- 测试通过。
256-
257-
步骤
258-
^^^^
259-
260-
见 `定时任务调度 <#定时任务调度>`__
261-
262-
优矿(Uqer)集成
263-
---------------------
264-
265-
一. 推送方式
266-
~~~~~~~~~~~~
267-
268-
| 适用于云服务器环境,例如阿里云;特点是稳定、高效,集成简单。
269-
| 开发中,暂不支持。
270-
271-
二. 抓取方式
272-
~~~~~~~~~~~~
273-
274-
采用定时轮询的方式。
275-
276-
准备工作
277-
^^^^^^^^
278-
279-
- 部署策略易。
280-
- 测试通过。
281-
282-
步骤
283-
^^^^
284-
285-
见 `定时任务调度 <#定时任务调度>`__
286-
287-
果仁(Guorn)集成
73+
策略集成
28874
---------------------
289-
290-
一. 推送方式
291-
~~~~~~~~~~~~
292-
293-
| 不支持。
294-
295-
二. 抓取方式
296-
~~~~~~~~~~~~
297-
298-
采用定时轮询的方式。
299-
300-
准备工作
301-
^^^^^^^^
302-
303-
- 部署策略易。
304-
- 测试通过。
305-
306-
步骤
307-
^^^^
308-
309-
见 `定时任务调度 <#定时任务调度>`__
310-
311-
字段要求
312-
^^^^^^^^
313-
314-
见策略易《用户手册.txt》的“查询投资组合”章节,可通过策略易菜单“帮助>查看帮助”访问。
75+
见《`策略集成说明 <docs/online-quant-integration.rst>`_》
31576

31677
其他语言 SDK
31778
------------
@@ -324,7 +85,3 @@ C# SDK
32485
32586
.. |策略交流| image:: http://pub.idqqimg.com/wpa/images/group.png
32687
:target: http://shang.qq.com/wpa/qunwpa?idkey=1ce867356702f5f7c56d07d5c694e37a3b9a523efce199bb0f6ff30410c6185d%22
327-
328-
.. _米筐(RiceQuant): http://www.ricequant.com
329-
330-
.. _scripts/strategyease_sdk_installer.ipynb: https://raw.githubusercontent.com/sinall/StrategyEase-Python-SDK/master/scripts/strategyease_sdk_installer.ipynb

0 commit comments

Comments
 (0)