vnpy/README.md

215 lines
7.9 KiB
Markdown
Raw Normal View History

2017-06-07 13:13:59 +00:00
# vn.py - By Traders, For Traders.
2015-03-03 09:54:12 +00:00
---
2017-06-07 13:13:59 +00:00
### 简介
2017-01-07 07:05:51 +00:00
2017-06-07 13:13:59 +00:00
vn.py是一套基于Python的开源量化交易程序开发框架起源于国内私募的自主量化交易系统。2015年初项目启动时只是单纯的交易API接口的Python封装。随着业内关注度的上升和社区不断的贡献目前已经一步步成长为一套全面的交易程序开发框架用户群体也日渐多样化包括私募基金、券商自营和资管、期货资管和子公司、高校研究机构和专业个人投资者等。
2017-01-07 07:05:51 +00:00
2017-06-07 13:13:59 +00:00
---
### 环境准备
2017-01-07 07:05:51 +00:00
2017-06-07 13:13:59 +00:00
1. 支持的操作系统Windows 7/8/10/Server 2008
2. 安装[MongoDB](https://www.mongodb.org/downloads#production),并[将MongoDB配置为系统服务](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/#configure-a-windows-service-for-mongodb-community-edition)
3. 安装[Anaconda](http://www.continuum.io/downloads)**注意必须是Python 2.7 32位版本**
4. 安装[Visual C++ Redistributable Packages for VS2013 x86版本](https://support.microsoft.com/en-us/help/3138367/update-for-visual-c-2013-and-visual-c-redistributable-package)
2017-01-07 07:05:51 +00:00
2017-06-07 13:13:59 +00:00
---
### 安装
2017-01-07 07:05:51 +00:00
2017-06-07 13:13:59 +00:00
**方法1**
在[这里](https://github.com/vnpy/vnpy/releases)下载最新版本解压后运行install.bat自动安装。
**方法2**
```
pip install vnpy pymongo msgpack-python websocket-client qdarkstyle
conda install -c quantopian ta-lib=0.4.9
```
2016-06-11 09:10:20 +00:00
2016-02-21 09:13:51 +00:00
---
### Quick Start
2017-06-07 13:13:59 +00:00
1. 在[SimNow](http://simnow.com.cn/)注册CTP仿真账号记下你的**账号、密码、经纪商编号**,然后下载快期查询你的**交易和行情服务器地址**
2016-02-21 09:21:48 +00:00
2017-06-07 13:13:59 +00:00
2. 找到你的Anaconda安装目录打开Anaconda2\Lib\site-packages\vnpy-1.6.2b0-py2.7.egg\vnpy\trader\gateway\ctpGateway\CTP_connect.json修改账号、密码、服务器等为上一步注册完成后你的信息注意使用专门的编程编辑器如Sublime Text等防止json编码出错
2016-02-21 09:21:48 +00:00
2017-06-07 13:13:59 +00:00
3. 在任意目录将以下内容保存为run.py并双击运行若无法双击则在当前目录按住Shift点鼠标右键打开cmd输入python run.py运行
2016-02-21 09:21:48 +00:00
2017-06-07 13:13:59 +00:00
```
# encoding: UTF-8
# 重载sys模块设置默认字符串编码方式为utf8
import sys
reload(sys)
sys.setdefaultencoding('utf8')
# vn.trader模块
from vnpy.event import EventEngine
from vnpy.trader.vtEngine import MainEngine
from vnpy.trader.uiQt import qApp
from vnpy.trader.uiMainWindow import MainWindow
# 加载底层接口
from vnpy.trader.gateway import ctpGateway
2016-02-21 09:21:48 +00:00
2017-06-07 13:13:59 +00:00
# 加载上层应用
from vnpy.trader.app import riskManager, ctaStrategy
2016-02-21 09:21:48 +00:00
2017-06-07 13:13:59 +00:00
#----------------------------------------------------------------------
def main():
2017-06-07 13:20:04 +00:00
"""主程序入口"""
# 创建事件引擎
ee = EventEngine()
2016-02-21 09:21:48 +00:00
2017-06-07 13:20:04 +00:00
# 创建主引擎
me = MainEngine(ee)
2016-02-21 09:21:48 +00:00
2017-06-07 13:20:04 +00:00
# 添加交易接口
me.addGateway(ctpGateway)
2017-06-07 13:20:04 +00:00
# 添加上层应用
me.addApp(riskManager)
me.addApp(ctaStrategy)
2016-02-21 09:21:48 +00:00
2017-06-07 13:20:04 +00:00
# 创建主窗口
mw = MainWindow(me, ee)
mw.showMaximized()
2016-02-21 09:13:51 +00:00
2017-06-07 13:20:04 +00:00
# 在主线程中启动Qt事件循环
sys.exit(qApp.exec_())
2017-06-07 13:13:59 +00:00
if __name__ == '__main__':
2017-06-07 13:20:04 +00:00
main()
2017-06-07 13:13:59 +00:00
```
2016-02-21 09:13:51 +00:00
2017-06-07 13:13:59 +00:00
更多使用方法方法请参考examples下的目录。
---
### 用户文档
[https://github.com/vnpy/vnpy/wiki](https://github.com/vnpy/vnpy/wiki)
2017-06-07 13:13:59 +00:00
### 开发工具推荐
2016-02-21 09:13:51 +00:00
* [WingIDE](http://wingware.com/)非常好用的Python集成开发环境作者就是用它写的vn.py
2016-02-21 09:21:48 +00:00
2016-02-21 09:13:51 +00:00
* [Robomongo](https://robomongo.org/)MongoDB的图形化客户端方便监控和修改数据
2016-02-21 09:21:48 +00:00
2016-02-21 09:13:51 +00:00
* [Sublime Text](http://www.sublimetext.com/)针对编程的文本编辑器当然你也可以使用Vim或者Emacs
2016-02-21 09:21:48 +00:00
2016-02-21 09:13:51 +00:00
* [PyQtGraph](http://www.pyqtgraph.org/)适用于开发实时更新数据的图表如Tick图、K线图、期权波动率曲线等Matplotlib渲染开销太大用于实盘绘图可能拖慢整个程序
2016-02-21 09:21:48 +00:00
2016-02-21 09:13:51 +00:00
* [Visual Studio 2013](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)这个就不多说了作者编译API封装用的是2013版本
2017-06-07 13:13:59 +00:00
---
### 项目结构
2017-06-07 13:13:59 +00:00
1. 丰富的Python交易和数据API接口vnpy.api基本覆盖了国内外所有常规交易品种股票、期货、期权、外汇、外盘、比特币具体包括
2017-06-07 13:13:59 +00:00
- CTPctp
2017-06-07 13:13:59 +00:00
- 飞马femas
2017-06-07 13:13:59 +00:00
- LTSlts
2017-06-07 13:13:59 +00:00
- 中信证券期权cshshlp
2017-06-07 13:13:59 +00:00
- 金仕达黄金ksgold
2017-06-07 13:13:59 +00:00
- 金仕达期权ksotp
2017-06-07 13:13:59 +00:00
- 飞鼠sgit
2017-06-07 13:13:59 +00:00
- 飞创xspeed
2017-06-07 13:13:59 +00:00
- QDPqdp
2017-06-07 13:13:59 +00:00
- 上海直达期货shzd
2017-06-07 13:13:59 +00:00
- Interactive Brokersib
2017-06-07 13:13:59 +00:00
- OANDAoanda
2017-06-07 13:13:59 +00:00
- OKCOINokcoin
2017-06-07 13:13:59 +00:00
- 火币huobi
2017-06-07 13:13:59 +00:00
- 链行lhang
2017-06-07 13:13:59 +00:00
- 通联数据datayes
2017-06-07 13:13:59 +00:00
2. 简洁易用的事件驱动引擎vnpy.event作为事件驱动型交易程序的核心
2017-06-07 13:13:59 +00:00
3. 支持服务器端数据推送的RPC框架vnpy.rpc用于实现多进程分布式架构的交易系统
2017-06-07 13:13:59 +00:00
4. 开箱即用的实盘交易平台框架vnpy.trader整合了多种交易接口并针对具体策略算法和功能开发提供了简洁易用的API用于快速构建交易员所需的量化交易程序应用举例
2017-06-07 13:13:59 +00:00
* 同时登录多个交易接口,在一套界面上监控多种市场的行情和多种资产账户的资金、持仓、委托、成交情况
2017-06-07 13:13:59 +00:00
* 支持跨市场套利CTP期货和LTS证券、境内外套利CTP期货和IB外盘、多市场数据整合实时预测走势CTP的股指期货数据、IB的外盘A50数据、Wind的行业指数数据等策略应用
2017-06-07 13:13:59 +00:00
* CTA策略引擎模块在保持易用性的同时允许用户针对CTA类策略运行过程中委托的报撤行为进行细粒度控制降低交易滑点、实现高频策略
2017-06-07 13:13:59 +00:00
* 实盘行情记录支持Tick和K线数据的落地用于策略开发回测以及实盘运行初始化
2017-06-07 13:13:59 +00:00
5. 关于vn.py项目的应用演示examples对于新手而言可以从这里开始学习vn.py项目的使用方式
2017-06-07 13:13:59 +00:00
5. 关于项目在实盘交易中的一些使用指南tutorial
2017-06-07 13:13:59 +00:00
6. vn.py项目的Docker镜像docker目前尚未完成
2017-06-07 13:13:59 +00:00
7. [官网](http://vnpy.org)和[知乎专栏](http://zhuanlan.zhihu.com/vn-py)内容包括vn.py项目的开发教程和Python在量化交易领域的应用研究等内容
2017-06-07 13:13:59 +00:00
7. 官方交流QQ群262656087管理较严格定期清除长期潜水的成员
---
2017-06-07 13:13:59 +00:00
### 贡献代码
2017-06-07 13:13:59 +00:00
vn.py使用github托管其源代码如果希望贡献代码请使用github的PR(Pull Request)的流程:
1. [创建 Issue](https://github.com/vnpy/vnpy/issues/new) - 对于较大的改动(如新功能,大型重构等)最好先开issue讨论一下较小的improvement(如文档改进bugfix等)直接发PR即可
1. Fork [vn.py](https://github.com/vnpy/vnpy) - 点击右上角**Fork**按钮
1. 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/)
1. 从**dev**创建你自己的feature branch: ```git checkout -b $my_feature_branch dev```
1. 在$my_feature_branch上修改并将修改push到你的fork上
1. 创建从你的fork的$my_feature_branch分支到主项目的**dev**分支的[Pull Request] - [在此](https://github.com/vnpy/vnpy/compare?expand=1)点击**compare across forks**选择需要的fork和branch创建PR
1. 等待review, 需要继续改进或者被Merge!
2017-06-07 13:13:59 +00:00
---
### 项目捐赠
过去的半年中陆续收到了许多用户的捐赠在此深表感谢所有的捐赠资金都投入到了vn.py社区基金中用于支持vn.py项目的运作。最近主要的一个支出是相关文档编写目前来看文档完成的速度和质量都显著超出预期。
先强调一下:**vn.py是开源项目可以永久免费使用并没有强制捐赠的要求**
捐赠方式支付宝3216630132@qq.com*晓优)
计划长期维护一份捐赠清单,所以请在留言中注明是项目捐赠以及捐赠人的名字(当然想匿名的用户就随意了)。
2016-02-21 09:13:51 +00:00
---
### 联系作者
2016-03-06 06:08:38 +00:00
作者知乎名用python的交易员想要联系作者可以通过知乎私信
2015-03-03 09:54:12 +00:00
2016-02-21 09:13:51 +00:00
---
### License
2015-03-17 01:44:33 +00:00
MIT