From 06797b475f54a0d2c1256b058c80869685b3ce82 Mon Sep 17 00:00:00 2001 From: "vn.py" Date: Tue, 17 Sep 2019 22:48:20 +0800 Subject: [PATCH] [Mod] update README.md --- .github/ISSUE_TEMPLATE.md | 4 +- README.md | 114 +++++++++++++++++++++----------------- vnpy/__init__.py | 2 +- 3 files changed, 67 insertions(+), 53 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d0d205ee..f37c5876 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,8 +1,8 @@ ## 环境 * 操作系统: 如Windows 10或者Ubuntu 18.04 -* Anaconda版本: 如Anaconda 18.12 Python 3.7 64位 -* vn.py版本: 如v2.0发行版或者dev branch 20190101（下载日期） +* Python版本: 如VNStudio-2.0.6 +* vn.py版本: 如v2.0.5发行版或者dev branch 20190101（下载日期） ## Issue类型 三选一：Bug/Enhancement/Question diff --git a/README.md b/README.md index 4ed0dc18..93e04168 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

- + @@ -20,9 +20,9 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1

-在使用vn.py进行二次开发（策略、模块等）的过程中有任何疑问，请查看[**vn.py项目文档**](https://www.vnpy.com/docs/cn/index.html)，如果无法解决请前往[**官方社区论坛**](https://www.vnpy.com/forum/)的【提问求助】板块寻求帮助，也欢迎在【经验分享】板块分享你的使用心得！ +在使用vn.py进行二次开发（策略、模块等）的过程中有任何疑问，请查看[**vn.py项目文档**]（https://www.vnpy.com/docs/cn/index.html），如果无法解决请前往[**官方社区论坛**]（https://www.vnpy.com/forum/）的【提问求助】板块寻求帮助，也欢迎在【经验分享】板块分享你的使用心得！ -2.0版本基于Python 3.7全新重构开发，如需Python 2上的版本请点击：[长期支持版本v1.9.2 LTS](https://github.com/vnpy/vnpy/tree/v1.9.2-LTS)。 +2.0版本基于Python 3.7全新重构开发，如需Python 2上的版本请点击：[长期支持版本v1.9.2 LTS]（https://github.com/vnpy/vnpy/tree/v1.9.2-LTS）。 ## 功能特点 @@ -32,49 +32,61 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1 * 国内市场 - * CTP(ctp)：国内期货、期权 + * CTP（ctp）：国内期货、期权 - * CTP Mini(mini)：国内期货、期权 + * CTP Mini（mini）：国内期货、期权 - * 飞马(femas)：国内期货 + * CTP证券（sopt）：ETF期权 - * 宽睿(oes)：国内证券（A股） + * 飞马（femas）：国内期货 - * 中泰XTP(xtp)：国内证券（A股） + * 宽睿（oes）：国内证券（A股） - * 华鑫奇点(tora)：国内证券（A股） + * 中泰XTP（xtp）：国内证券（A股） + + * 华鑫奇点（tora）：国内证券（A股） + + * 鑫管家（xgj）：期货资管 + + * 融航（rohon）：期货资管 * 海外市场 - - * 富途证券(futu)：港股、美股 - * 老虎证券(tiger)：全球证券、期货、期权、外汇等 + * 富途证券（futu）：港股、美股 - * Interactive Brokers(ib)：全球证券、期货、期权、外汇等 + * 老虎证券（tiger）：全球证券、期货、期权、外汇等 - * 易盛9.0外盘(tap)：全球期货 + * Interactive Brokers（ib）：全球证券、期货、期权、外汇等 + + * 易盛9.0外盘（tap）：全球期货 + + * 直达期货（da）：全球期货 * 数字货币 - * BitMEX(bitmex)：数字货币期货、期权、永续合约 + * BitMEX（bitmex）：数字货币期货、期权、永续合约 - * OKEX合约(okexf)：数字货币期货 + * OKEX永续（okexs）：数字货币永续合约 - * 火币合约(hbdm)：数字货币期货 + * OKEX合约（okexf）：数字货币期货 - * 币安(binance)：数字货币现货 + * 火币合约（hbdm）：数字货币期货 - * OKEX(okex)：数字货币现货 + * 币安（binance）：数字货币现货 - * 火币(huobi)：数字货币现货 + * OKEX（okex）：数字货币现货 - * Bitfinex(bitfinex)：数字货币现货 + * 火币（huobi）：数字货币现货 - * 1Token(onetoken)：数字货币券商（现货、期货） + * Bitfinex（bitfinex）：数字货币现货 + + * Coinbase（coinbase）：数字货币现货 + + * 1Token（onetoken）：数字货币券商（现货、期货） * 特殊应用 - * RPC服务(rpc)：跨进程通讯接口，用于分布式架构 + * RPC服务（rpc）：跨进程通讯接口，用于分布式架构 3. 开箱即用的各类量化策略交易应用（vnpy.app）： @@ -82,6 +94,8 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1 * cta_backtester：CTA策略回测模块，无需使用Jupyter Notebook，直接使用图形界面直接进行策略回测分析、参数优化等相关工作 + * spread_trading：价差交易模块，支持自定义价差，实时计算价差行情和持仓，支持半自动价差算法交易以及全自动价差策略交易两种模式 + * algo_trading：算法交易模块，提供多种常用的智能交易算法：TWAP、Sniper、Iceberg、BestLimit等等，支持常用算法配置保存 * script_trader：脚本策略模块，针对多标的组合类交易策略设计，同时也可以直接在命令行中实现REPL指令形式的交易，不支持回测功能 @@ -102,19 +116,19 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1 7. Python高性能K线图表（vnpy.chart），支持大数据量图表显示以及实时数据更新功能。 -8. [社区论坛](http://www.vnpy.com)和[知乎专栏](http://zhuanlan.zhihu.com/vn-py)，内容包括vn.py项目的开发教程和Python在量化交易领域的应用研究等内容。 +8. [社区论坛]（http://www.vnpy.com）和[知乎专栏]（http://zhuanlan.zhihu.com/vn-py），内容包括vn.py项目的开发教程和Python在量化交易领域的应用研究等内容。 9. 官方交流群262656087（QQ），管理严格（定期清除长期潜水的成员），入群费将捐赠给vn.py社区基金。 ## 环境准备 -* 推荐使用vn.py团队为量化交易专门打造的Python发行版[VNStudio-2.0.4](https://download.vnpy.com/vnstudio-2.0.4-r.exe)，内置了最新版的vn.py框架以及VN Station量化管理平台，无需手动安装 +* 推荐使用vn.py团队为量化交易专门打造的Python发行版[VNStudio-2.0.6]（https://download.vnpy.com/vnstudio-2.0.6.exe），内置了最新版的vn.py框架以及VN Station量化管理平台，无需手动安装 * 支持的系统版本：Windows 7以上/Windows Server 2008以上/Ubuntu 18.04 LTS * 支持的Python版本：Python 3.7 64位（**注意必须是Python 3.7 64位版本**） ## 安装步骤 -在[这里](https://github.com/vnpy/vnpy/releases)下载最新版本，解压后运行以下命令安装： +在[这里]（https://github.com/vnpy/vnpy/releases）下载最新版本，解压后运行以下命令安装： **Windows** @@ -127,9 +141,9 @@ vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1 ## 使用指南 -1. 在[SimNow](http://www.simnow.com.cn/)注册CTP仿真账号，并在[该页面](http://www.simnow.com.cn/product.action)获取经纪商代码以及交易行情服务器地址。 +1. 在[SimNow]（http://www.simnow.com.cn/）注册CTP仿真账号，并在[该页面]（http://www.simnow.com.cn/product.action）获取经纪商代码以及交易行情服务器地址。 -2. 在[vn.py社区论坛](https://www.vnpy.com/forum/)注册获得VN Station账号密码（论坛账号密码即是） +2. 在[vn.py社区论坛]（https://www.vnpy.com/forum/）注册获得VN Station账号密码（论坛账号密码即是） 3. 启动VN Station（安装VNConda后会在桌面自动创建快捷方式），输入上一步的账号密码登录 @@ -153,24 +167,24 @@ from vnpy.gateway.ctp import CtpGateway from vnpy.app.cta_strategy import CtaStrategyApp from vnpy.app.cta_backtester import CtaBacktesterApp -def main(): +def main（）: """Start VN Trader""" - qapp = create_qapp() + qapp = create_qapp（） - event_engine = EventEngine() - main_engine = MainEngine(event_engine) + event_engine = EventEngine（） + main_engine = MainEngine（event_engine） - main_engine.add_gateway(CtpGateway) - main_engine.add_app(CtaStrategyApp) - main_engine.add_app(CtaBacktesterApp) + main_engine.add_gateway（CtpGateway） + main_engine.add_app（CtaStrategyApp） + main_engine.add_app（CtaBacktesterApp） - main_window = MainWindow(main_engine, event_engine) - main_window.showMaximized() + main_window = MainWindow（main_engine, event_engine） + main_window.showMaximized（） - qapp.exec() + qapp.exec（） if __name__ == "__main__": - main() + main（） ``` 在该目录下打开CMD（按住Shift->点击鼠标右键->在此处打开命令窗口/PowerShell）后运行下列命令启动VN Trader： @@ -179,27 +193,27 @@ if __name__ == "__main__": ## 贡献代码 -vn.py使用Github托管其源代码，如果希望贡献代码请使用github的PR(Pull Request)的流程: +vn.py使用Github托管其源代码，如果希望贡献代码请使用github的PR（Pull Request）的流程: -1. [创建 Issue](https://github.com/vnpy/vnpy/issues/new) - 对于较大的改动(如新功能，大型重构等)最好先开issue讨论一下，较小的improvement(如文档改进，bugfix等)直接发PR即可 +1. [创建 Issue]（https://github.com/vnpy/vnpy/issues/new） - 对于较大的改动（如新功能，大型重构等）最好先开issue讨论一下，较小的improvement（如文档改进，bugfix等）直接发PR即可 -2. Fork [vn.py](https://github.com/vnpy/vnpy) - 点击右上角**Fork**按钮 +2. Fork [vn.py]（https://github.com/vnpy/vnpy） - 点击右上角**Fork**按钮 3. Clone你自己的fork: ```git clone https://github.com/$userid/vnpy.git``` - * 如果你的fork已经过时，需要手动sync：[https://help.github.com/articles/syncing-a-fork/](https://help.github.com/articles/syncing-a-fork/) + * 如果你的fork已经过时，需要手动sync：[https://help.github.com/articles/syncing-a-fork/]（https://help.github.com/articles/syncing-a-fork/） 4. 从**dev**创建你自己的feature branch: ```git checkout -b $my_feature_branch dev``` 5. 在$my_feature_branch上修改并将修改push到你的fork上 -6. 创建从你的fork的$my_feature_branch分支到主项目的**dev**分支的[Pull Request] - [在此](https://github.com/vnpy/vnpy/compare?expand=1)点击**compare across forks**，选择需要的fork和branch创建PR +6. 创建从你的fork的$my_feature_branch分支到主项目的**dev**分支的[Pull Request] - [在此]（https://github.com/vnpy/vnpy/compare?expand=1）点击**compare across forks**，选择需要的fork和branch创建PR 7. 等待review, 需要继续改进，或者被Merge! 在提交代码的时候，请遵守以下规则，以提高代码质量： - * 使用[autopep8](https://github.com/hhatto/autopep8)格式化你的代码。运行```autopep8 --in-place --recursive . ```即可。 - * 使用[flake8](https://pypi.org/project/flake8/)检查你的代码，确保没有error和warning。在项目根目录下运行```flake8```即可。 + * 使用[autopep8]（https://github.com/hhatto/autopep8）格式化你的代码。运行```autopep8 --in-place --recursive . ```即可。 + * 使用[flake8]（https://pypi.org/project/flake8/）检查你的代码，确保没有error和warning。在项目根目录下运行```flake8```即可。 @@ -217,10 +231,10 @@ vn.py使用Github托管其源代码，如果希望贡献代码请使用github的 ## 其他内容 -* [获取帮助](https://github.com/vnpy/vnpy/blob/dev/docs/SUPPORT.md) -* [社区行为准侧](https://github.com/vnpy/vnpy/blob/dev/docs/CODE_OF_CONDUCT.md) -* [Issue模板](https://github.com/vnpy/vnpy/blob/dev/docs/ISSUE_TEMPLATE.md) -* [PR模板](https://github.com/vnpy/vnpy/blob/dev/docs/PULL_REQUEST_TEMPLATE.md) +* [获取帮助]（https://github.com/vnpy/vnpy/blob/dev/docs/SUPPORT.md） +* [社区行为准侧]（https://github.com/vnpy/vnpy/blob/dev/docs/CODE_OF_CONDUCT.md） +* [Issue模板]（https://github.com/vnpy/vnpy/blob/dev/docs/ISSUE_TEMPLATE.md） +* [PR模板]（https://github.com/vnpy/vnpy/blob/dev/docs/PULL_REQUEST_TEMPLATE.md） diff --git a/vnpy/__init__.py b/vnpy/__init__.py index ff6ef86d..962c851b 100644 --- a/vnpy/__init__.py +++ b/vnpy/__init__.py @@ -1 +1 @@ -__version__ = "2.0.6" +__version__ = "2.0.7"