Rename ShiPanE to StrategyEase

Author: sinall

README.rst

@@ -1,26 +1,26 @@
-ShiPanE-Python-SDK
+StrategyEase-Python-SDK
 ==================
 
-实盘易（ShiPanE）Python SDK，通达信自动化交易 API。
+策略易（StrategyEase）Python SDK。
 
-| 实盘易是\ `爱股网 <http://www.iguuu.com>`__\ 旗下的股票自动化解决方案；提供基于 HTTP 协议的 RESTFul Service，从而管理通达信等交易终端。
+| 策略易是\ `爱股网 <http://www.iguuu.com>`__\ 旗下的股票自动化解决方案；提供基于 HTTP 协议的 RESTFul Service，从而管理通达信等交易终端。
 | 详情见：http://www.iguuu.com/e
-| 交流QQ群：11527956 |实盘易-股票自动交易|
+| 交流QQ群：11527956 |策略交流|
 |
 
 .. contents:: **目录**
 
 原理概述
 --------
-- 实盘易通过调用 WINDOWS API 对通达信进行操作。
-- 实盘易提供基于 HTTP 协议的 RESTFul Service/API。
-- SDK 对 API 进行了封装（由 shipane_sdk/client.py 中的 Client 类实现）。
+- 策略易通过调用 WINDOWS API 对通达信进行操作。
+- 策略易提供基于 HTTP 协议的 RESTFul Service/API。
+- SDK 对 API 进行了封装（由 strategyease_sdk/client.py 中的 Client 类实现）。
 - 本地策略或量化交易平台（目前支持聚宽、米筐、优矿）的模拟交易通过调用 SDK 实现自动下单。
 
 功能介绍
 --------
 
-- 简单的实盘易 HTTP API 封装，见 shipane_sdk/client.py
+- 简单的策略易 HTTP API 封装，见 strategyease_sdk/client.py
 - 多账号自动新股申购（自动打新）
 - 多账号自动逆回购
 - 定时批量下单
@@ -36,11 +36,11 @@ ShiPanE-Python-SDK
 
   import logging
 
-  import shipane_sdk
+  import strategyease_sdk
 
   logging.basicConfig(level=logging.DEBUG)
 
-  client = shipane_sdk.Client(host='localhost', port=8888, key='')
+  client = strategyease_sdk.Client(host='localhost', port=8888, key='')
   account_info = client.get_account('title:monijiaoyi')
   print(account_info)
 
@@ -49,17 +49,17 @@ ShiPanE-Python-SDK
 测试用例
 --------------
 
-实盘易 HTTP API 封装对应的测试用例见：
+策略易 HTTP API 封装对应的测试用例见：
 
-+------------+-------------------------------------------------+
-| 查询及下单 | tests/shipane_sdk/test_client.py                |
-+------------+-------------------------------------------------+
-| 客户端管理 | tests/shipane_sdk/test_client_management.py     |
-+------------+-------------------------------------------------+
-| 融资融券   | tests/shipane_sdk/test_client_margin_trading.py |
-+------------+-------------------------------------------------+
-| 其他       | tests/shipane_sdk/...                           |
-+------------+-------------------------------------------------+
++------------+------------------------------------------------------+
+| 查询及下单 | tests/strategyease_sdk/test_client.py                |
++------------+------------------------------------------------------+
+| 客户端管理 | tests/strategyease_sdk/test_client_management.py     |
++------------+------------------------------------------------------+
+| 融资融券   | tests/strategyease_sdk/test_client_margin_trading.py |
++------------+------------------------------------------------------+
+| 其他       | tests/strategyease_sdk/...                           |
++------------+------------------------------------------------------+
 
 定时任务调度
 --------------
@@ -83,40 +83,40 @@ Windows
 - 安装 Python 3.5（建议安装 `Anaconda3-4.2.0 <https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/>`_）
 - cmd 中运行
 
-+--------+---------------------------------------------------------------+
-| 正式版 | :code:`pip install --no-binary shipane_sdk shipane_sdk`       |
-+--------+---------------------------------------------------------------+
-| 测试版 | :code:`pip install --pre --no-binary shipane_sdk shipane_sdk` |
-+--------+---------------------------------------------------------------+
++--------+-------------------------------------------------------------------------+
+| 正式版 | :code:`pip install --no-binary strategyease_sdk strategyease_sdk`       |
++--------+-------------------------------------------------------------------------+
+| 测试版 | :code:`pip install --pre --no-binary strategyease_sdk strategyease_sdk` |
++--------+-------------------------------------------------------------------------+
 
 配置
 ^^^^
 
-- cmd 中运行：:code:`explorer %UserProfile%\.shipane_sdk\config`
+- cmd 中运行：:code:`explorer %UserProfile%\.strategyease_sdk\config`
 - 修改 scheduler.ini 中的配置（建议使用Notepad++）
 
 运行
 ^^^^
 
-- cmd 下运行：:code:`shipane-scheduler`
+- cmd 下运行：:code:`strategyease-scheduler`
 
 升级
 ^^^^
 
 - cmd 中运行
 
-+--------+-----------------------------------------------------------------------------------+
-| 正式版 | :code:`pip install --upgrade --no-deps --no-binary shipane_sdk shipane_sdk`       |
-+--------+-----------------------------------------------------------------------------------+
-| 测试版 | :code:`pip install --upgrade --pre --no-deps --no-binary shipane_sdk shipane_sdk` |
-+--------+-----------------------------------------------------------------------------------+
++--------+---------------------------------------------------------------------------------------------+
+| 正式版 | :code:`pip install --upgrade --no-deps --no-binary strategyease_sdk strategyease_sdk`       |
++--------+---------------------------------------------------------------------------------------------+
+| 测试版 | :code:`pip install --upgrade --pre --no-deps --no-binary strategyease_sdk strategyease_sdk` |
++--------+---------------------------------------------------------------------------------------------+
 
 - 参考 scheduler-template.ini 修改 scheduler.ini
 
 日志
 ^^^^
 
-- cmd 中运行：:code:`explorer %UserProfile%\AppData\Local\爱股网\实盘易`
+- cmd 中运行：:code:`explorer %UserProfile%\AppData\Local\爱股网\策略易`
 
 Mac/Linux
 ~~~~~~~~~
@@ -127,32 +127,32 @@ Mac/Linux
 - 安装 Python 3.5
 - terminal 中运行
 
-+--------+---------------------------------------------------------------+
-| 正式版 | :code:`pip install --no-binary shipane_sdk shipane_sdk`       |
-+--------+---------------------------------------------------------------+
-| 测试版 | :code:`pip install --pre --no-binary shipane_sdk shipane_sdk` |
-+--------+---------------------------------------------------------------+
++--------+-------------------------------------------------------------------------+
+| 正式版 | :code:`pip install --no-binary strategyease_sdk strategyease_sdk`       |
++--------+-------------------------------------------------------------------------+
+| 测试版 | :code:`pip install --pre --no-binary strategyease_sdk strategyease_sdk` |
++--------+-------------------------------------------------------------------------+
 
 配置
 ^^^^
 
-- 修改 ~/.shipane_sdk/config/scheduler.ini
+- 修改 ~/.strategyease_sdk/config/scheduler.ini
 
 运行
 ^^^^
 
-- terminal 中运行：:code:`shipane-scheduler:code:`
+- terminal 中运行：:code:`strategyease-scheduler:code:`
 
 升级
 ^^^^
 
 - terminal 中运行
 
-+--------+-----------------------------------------------------------------------------------+
-| 正式版 | :code:`pip install --upgrade --no-deps --no-binary shipane_sdk shipane_sdk`       |
-+--------+-----------------------------------------------------------------------------------+
-| 测试版 | :code:`pip install --upgrade --pre --no-deps --no-binary shipane_sdk shipane_sdk` |
-+--------+-----------------------------------------------------------------------------------+
++--------+---------------------------------------------------------------------------------------------+
+| 正式版 | :code:`pip install --upgrade --no-deps --no-binary strategyease_sdk strategyease_sdk`       |
++--------+---------------------------------------------------------------------------------------------+
+| 测试版 | :code:`pip install --upgrade --pre --no-deps --no-binary strategyease_sdk strategyease_sdk` |
++--------+---------------------------------------------------------------------------------------------+
 
 - 参考 scheduler-template.ini 修改 scheduler.ini
 
@@ -167,18 +167,18 @@ Mac/Linux
 准备工作
 ^^^^^^^^
 
-- 部署实盘易。
+- 部署策略易。
 - 本地测试通过。
 - 远程测试通过。
 
 步骤
 ^^^^
 
-- 下载 `scripts/shipane_sdk_installer.ipynb`_ 并上传至“投资研究”根目录。
+- 下载 `scripts/strategyease_sdk_installer.ipynb`_ 并上传至“投资研究”根目录。
 - 打开该文件，设置参数：QUANT_NAME = 'joinquant'
 - 查看其它参数并根据需要进行修改。
 - 点击工具栏中的右箭头运行该文件，并检查窗口中打印的日志。
-- 修改 shipane_sdk_config.yaml，升级后需参考 shipane_sdk_config_template.yaml 进行修改。
+- 修改 strategyease_sdk_config.yaml，升级后需参考 strategyease_sdk_config_template.yaml 进行修改。
 - 修改策略代码，可参考如下示例：
 
   - examples/joinquant/simple\_strategy.py - 基本跟单用法（侵入式设计，不推荐）
@@ -192,9 +192,9 @@ Mac/Linux
 - 同步操作根据模拟盘持仓比例对实盘进行调整。
 - 同步操作依赖于“可用”资金。请留意配置文件中“撤销全部订单”相关选项。
 - “新股申购”不影响“可用”资金，并且不可被撤销，因此不影响同步功能。
-- 同步操作依赖于实盘易 API /adjustments；因此也依赖于“查询投资组合”API，使用前请先做好测试及配置。
+- 同步操作依赖于策略易 API /adjustments；因此也依赖于“查询投资组合”API，使用前请先做好测试及配置。
 - 同步操作使用“市价单”。
-- 如遇到策略报错“ImportError: No module named shipane_sdk”，请稍后重试。
+- 如遇到策略报错“ImportError: No module named strategyease_sdk”，请稍后重试。
 - 量化平台模拟交易运行中升级 SDK，需重启生效。
 
 二. 抓取方式
@@ -205,7 +205,7 @@ Mac/Linux
 准备工作
 ^^^^^^^^
 
-- 部署实盘易。
+- 部署策略易。
 - 测试通过。
 
 步骤
@@ -224,14 +224,14 @@ Mac/Linux
 准备工作
 ^^^^^^^^
 
-- 部署实盘易。
+- 部署策略易。
 - 本地测试通过。
 - 远程测试通过。
 
 步骤
 ^^^^
 
-- 下载 `scripts/shipane_sdk_installer.ipynb`_ 并上传至“策略研究”根目录。
+- 下载 `scripts/strategyease_sdk_installer.ipynb`_ 并上传至“策略研究”根目录。
 - 打开该文件，设置参数：QUANT_NAME = 'ricequant'
 - 查看其它参数并根据需要进行修改。
 - 点击工具栏中的右箭头运行该文件，并检查窗口中打印的日志。
@@ -251,7 +251,7 @@ Mac/Linux
 准备工作
 ^^^^^^^^
 
-- 部署实盘易。
+- 部署策略易。
 - 测试通过。
 
 步骤
@@ -276,7 +276,7 @@ Mac/Linux
 准备工作
 ^^^^^^^^
 
-- 部署实盘易。
+- 部署策略易。
 - 测试通过。
 
 步骤
@@ -300,7 +300,7 @@ Mac/Linux
 准备工作
 ^^^^^^^^
 
-- 部署实盘易。
+- 部署策略易。
 - 测试通过。
 
 步骤
@@ -311,7 +311,7 @@ Mac/Linux
 字段要求
 ^^^^^^^^
 
-见实盘易《用户手册.txt》的“查询投资组合”章节，可通过实盘易菜单“帮助>查看帮助”访问。
+见策略易《用户手册.txt》的“查询投资组合”章节，可通过策略易菜单“帮助>查看帮助”访问。
 
 其他语言 SDK
 ------------
@@ -322,9 +322,9 @@ C# SDK
 | 由网友 @YBO（QQ：259219140）开发。
 | 见 `ShiPanETradingSDK <http://git.oschina.net/ybo1990/ShiPanETradingSDK>`_
 
-.. |实盘易-股票自动交易| image:: http://pub.idqqimg.com/wpa/images/group.png
+.. |策略交流| image:: http://pub.idqqimg.com/wpa/images/group.png
    :target: http://shang.qq.com/wpa/qunwpa?idkey=1ce867356702f5f7c56d07d5c694e37a3b9a523efce199bb0f6ff30410c6185d%22
 
 .. _米筐（RiceQuant）: http://www.ricequant.com
 
-.. _scripts/shipane_sdk_installer.ipynb: https://raw.githubusercontent.com/sinall/ShiPanE-Python-SDK/master/scripts/shipane_sdk_installer.ipynb
+.. _scripts/strategyease_sdk_installer.ipynb: https://raw.githubusercontent.com/sinall/StrategyEase-Python-SDK/master/scripts/strategyease_sdk_installer.ipynb

config/logging-template.ini

@@ -18,7 +18,7 @@ formatter=default
 args=(sys.stdout,)
 
 [handler_file]
-class=shipane_sdk.scheduler.FileHandler
+class=strategyease_sdk.scheduler.FileHandler
 interval=midnight
 backupCount=10
 formatter=default

…esearch/shipane_sdk_config_template.yaml …ch/strategyease_sdk_config_template.yamlconfig/online-quant/research/shipane_sdk_config_template.yaml renamed to config/online-quant/research/strategyease_sdk_config_template.yaml config/online-quant/research/shipane_sdk_config_template.yaml renamed to config/online-quant/research/strategyease_sdk_config_template.yaml

@@ -1,5 +1,5 @@
 # *********************************************************
-# 实盘易 SDK 配置
+# 策略易 SDK 配置
 # 如无特别说明，配置项修改后，将在策略重启后生效
 # 注意：
 # - 请勿在策略运行期间修改结构，比如 id 等关键信息
@@ -20,10 +20,10 @@ proxies:
         password: <password>
 
 # *********************************************************
-# 实盘易配置
+# 策略易配置
 # *********************************************************
 gateways:
-    # 实盘易-1 配置
+    # 策略易-1 配置
     -   id: gateway-1
         # 连接方式
         # DIRECT：直连，适用于有公网 IP 的环境
@@ -36,7 +36,7 @@ gateways:
         # 代理 ID
         # 连接方式为“代理”时需要设置
         proxy: default
-        # 实例 ID，即运行实盘易的计算机名
+        # 实例 ID，即运行策略易的计算机名
         # 连接方式为“代理”时需要设置
         instance-id: <instance-id>
         # 密钥
@@ -56,7 +56,7 @@ gateways:
                 # 其中 xxxx 为交易账号或交易账号后半段
                 query: account:xxxx
                 # 是否默认？
-                # 1 个实盘易只允许设置 1 个交易客户端为默认
+                # 1 个策略易只允许设置 1 个交易客户端为默认
                 default: true
                 # 其他资产价值
                 # 基金及其他非场内资产价值，该项配置用于校验账户
@@ -90,7 +90,7 @@ gateways:
                     - ^[\d]{5}$
                     - ^(204|131)
                     - !!str 888880
-    # 实盘易-2 配置
+    # 策略易-2 配置
     -   id: gateway-2
         # 连接方式
         connection-method: DIRECT

config/scheduler-template.ini

@@ -31,9 +31,9 @@
 
 
 ; *********************************************************
-; 实盘易配置
+; 策略易配置
 ; *********************************************************
-[ShiPanE]
+[StrategyEase]
 host=localhost
 port=8888
 key=
@@ -45,7 +45,7 @@ key=
 [ClientAliases]
 ; client 参数别名定义
 ; 下面的各个任务可能会用到相同的客户端，使用 client 参数别名可以简化配置
-; 取值可以参见实盘易帮助（帮助>查看帮助）
+; 取值可以参见策略易帮助（帮助>查看帮助）
 client1=account:45678
 client2=account:12345
 

examples/basic_example.py

@@ -2,10 +2,10 @@
 
 import logging
 
-import shipane_sdk
+import strategyease_sdk
 
 logging.basicConfig(level=logging.DEBUG)
 
-client = shipane_sdk.Client(host='localhost', port=8888, key='')
+client = strategyease_sdk.Client(host='localhost', port=8888, key='')
 account_info = client.get_account('title:monijiaoyi')
 print(account_info)

examples/joinquant/advanced_strategy.py

@@ -1,4 +1,4 @@
-import shipane_sdk
+import strategyease_sdk
 
 
 # 初始化函数，设定要操作的股票、基准等等
@@ -13,7 +13,7 @@ def initialize(context):
 def process_initialize(context):
     # 创建 StrategyManager 对象
     # 参数为配置文件中的 manager id
-    g.__manager = shipane_sdk.JoinQuantStrategyManagerFactory(context).create('manager-1')
+    g.__manager = strategyease_sdk.JoinQuantStrategyManagerFactory(context).create('manager-1')
 
 
 # 每个单位时间(如果按天回测,则每天调用一次,如果按分钟,则每分钟调用一次)调用一次