1. 修改vn.how目录名为vn.tutorial
2. 修改readme.md
This commit is contained in:
chenxy123
parent
f5dc13398f
commit
8576b91c43
155
README.md
155
README.md
@ -1,55 +1,16 @@
|
||||
# vn.py - 基于python的开源交易平台开发框架
|
||||
|
||||
---
|
||||
### 项目捐赠
|
||||
|
||||
vn.py项目两岁啦，感谢社区一直以来的热情支持，没有你们就没有今天的vn.py！
|
||||
过去一个季度中收到了开源社区用户相当金额的捐赠，在此深表感谢！所有的捐赠资金都投入到了vn.py社区基金中，用于支持vn.py项目的运作。最近主要的一个支出是相关文档编写，目前来看文档完成的速度和质量都显著超出预期。
|
||||
|
||||
最近提出希望捐赠的朋友挺多，决定开始接受捐赠。现阶段计划将收到的全部捐赠资金都投入到vn.py项目基金，用于支持后续的项目开发和各项活动。
|
||||
|
||||
在此先强调一下：**vn.py是开源项目，可以永久免费使用，并没有强制捐赠的要求！！！**
|
||||
先强调一下：**vn.py是开源项目，可以永久免费使用，并没有强制捐赠的要求！！！**
|
||||
|
||||
捐赠方式：支付宝3216630132@qq.com（*晓优）
|
||||
|
||||
计划长期维护一份捐赠清单，所以请在留言中注明是项目捐赠以及捐赠人的名字（当然想匿名的用户就随意了）。
|
||||
|
||||
---
|
||||
### 2016年vn.py项目计划回顾
|
||||
|
||||
转眼之间已经到了2016年的四季度，感谢广大用户的支持，vn.py项目在这一年中成长得十分迅速。截止2016年10月13日，Github上的Star已经从年初的583上升到了1672，Fork也从362上升到了987。目前在Github上量化交易相关的项目里，vn.py名列全球第三，仅次于zipline和tushare。为了让社区的成员们能比较全面的了解项目近况，这里对2016年初的项目计划做个简单的回顾。
|
||||
|
||||
**代码方面：**
|
||||
|
||||
1. 完善飞创、易盛等相对小众接口的添加，这块将由社区驱动，作者主要负责代码检查和管理（增加了vn.xspeed、vn.sgit、vn.okcoin、vn.shzd等接口，易盛暂时还未有计划）
|
||||
|
||||
2. 整理vn.py项目中API的具体版本号，保证封装接口的对应，这点已经有多位用户提起过，项目初期没有做详细记录所以很多API的版本号一时都较难对上（已完成）
|
||||
|
||||
3. Linux上API的编译以及vn.trader支持（已完成）
|
||||
|
||||
4. 基于VirtualBox的vn.py开发环境镜像，解决部分用户反映项目初期不知该如何搭建开发环境的问题，这个镜像会由官方长期维护下去（已完成）
|
||||
|
||||
**文章方面：**
|
||||
|
||||
1. 作者自己作为交易员的成长经历（通过知乎LIVE完成）
|
||||
|
||||
2. vn.trader的使用教程（已完成）
|
||||
|
||||
3. 将ta-lib（技术分析）和quantlib（金融工程和量化）整合到vn.trader中应用的教程，解决目前策略开发过程中技术指标和量化函数缺乏的问题（已完成）
|
||||
|
||||
4. 一套关于开发基于股指交易ETF期权的CTA策略的教程（未完成，上证50指数已经基本走成一条直线，本条工作暂时看不到意义了）
|
||||
|
||||
**社区方面：**
|
||||
|
||||
1. 重新建设官方网站，目前使用的是托管在Github Pages上的Hexo静态博客，一来功能比较有限，二来有些用户反映Github时不时会被墙，考虑基于Flask重建一个托管在国内的官网（已完成，基于Pelican的新官网）
|
||||
|
||||
2. 有用户提出建设互动性更强的网站作为交流平台（如论坛或者知乎Q&A类似的模式），这点在考虑中，主要制约因素是作者参与的时间，可能考虑和更多的资深用户合作是个好主意？（已完成，维恩的派论坛）
|
||||
|
||||
---
|
||||
### 论坛
|
||||
|
||||
新的论坛[维恩的派](http://www.vnpie.com)已经上线（感谢量衍投资对vn.py项目的支持）。
|
||||
|
||||
如果你在使用vn.py的过程中有任何疑问想求助或者经验想分享，欢迎到维恩的派上面发帖，项目作者和其他主要贡献者也会每天阅帖，保证回复的效率。
|
||||
|
||||
|
||||
---
|
||||
### Quick Start
|
||||
@ -92,8 +53,64 @@ vn.py项目两岁啦，感谢社区一直以来的热情支持，没有你们就
|
||||
* [Visual Studio 2013](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)：这个就不多说了（作者编译API封装用的是2013版本）
|
||||
|
||||
|
||||
---
|
||||
|
||||
##### 注意:
|
||||
### 项目结构
|
||||
|
||||
1. 丰富的Python交易和数据API接口（vn.api），基本覆盖了国内外所有常规交易品种（股票、期货、期权、外汇、外盘、比特币），具体包括：
|
||||
|
||||
- CTP（vn.ctp）
|
||||
|
||||
- 飞马（vn.femas）
|
||||
|
||||
- LTS（vn.lts）
|
||||
|
||||
- 金仕达黄金（vn.ksgold）
|
||||
|
||||
- 金仕达期权（vn.ksotp）
|
||||
|
||||
- 飞鼠（vn.sgit）
|
||||
|
||||
- 飞创（vn.xspeed）
|
||||
|
||||
- QDP（vn.qdp）
|
||||
|
||||
- 上海直达期货（vn.shzd）
|
||||
|
||||
- Interactive Brokers（vn.ib）
|
||||
|
||||
- OANDA（vn.oanda）
|
||||
|
||||
- OKCOIN（vn.okcoin）
|
||||
|
||||
- 火币（vn.huobi）
|
||||
|
||||
- 链行（vn.lhang）
|
||||
|
||||
- 通联数据（vn.datayes）
|
||||
|
||||
2. 简洁易用的事件驱动引擎（vn.event），作为事件驱动型交易程序的核心
|
||||
|
||||
3. 支持服务器端数据推送的RPC框架（vn.rpc），用于实现多进程分布式架构的交易系统
|
||||
|
||||
3. 针对如何使用API和事件驱动引擎开发交易程序的示例（vn.demo）
|
||||
|
||||
4. 开箱即用的实盘交易平台vn.trader（相比之下vn.demo仅建议学习用），整合了多种交易接口，并针对具体策略算法和功能开发提供了简洁易用的API，功能应用举例：
|
||||
|
||||
* 同时登录多个交易接口，在一套界面上监控多种市场的行情和多种资产账户的资金、持仓、委托、成交情况
|
||||
|
||||
* 支持跨市场套利（CTP期货和LTS证券）、境内外套利（CTP期货和IB外盘）、多市场数据整合实时预测走势（CTP的股指期货数据、IB的外盘A50数据、Wind的行业指数数据）等策略应用
|
||||
|
||||
* CTA策略引擎模块，在保持易用性的同时，允许用户针对CTA类策略运行过程中委托的报撤行为进行细粒度控制（降低交易滑点、实现高频策略）
|
||||
|
||||
5. 关于项目在实盘交易中的应用指南vn.tutorial
|
||||
|
||||
6. [官网](http://vnpy.org)和[知乎专栏](http://zhuanlan.zhihu.com/vn-py)，内容目前主要是《Python量化交易平台开发教程系列》，以及vn.py项目进展的更新
|
||||
|
||||
7. 官方交流QQ群262656087，管理较严格（定期清除长期潜水的成员）
|
||||
|
||||
---
|
||||
##### 注意事项
|
||||
|
||||
按照以上方式配置后，便可以使用vn.py的CTP, LTS, KSOTP等大多数交易接口，但在启动vtMain.py时， 你可能会遇到以下错误：
|
||||
|
||||
@ -121,7 +138,6 @@ python setup.py install
|
||||
```
|
||||
* OKCOIN - ```pip install websocket-client``` or ```conda install websocket-client```
|
||||
|
||||
|
||||
---
|
||||
### How To Contribute
|
||||
|
||||
@ -139,57 +155,6 @@ vn.py使用github托管其源代码，贡献代码使用github的PR(Pull Request
|
||||
|
||||
6. 等待review, 需要继续改进，或者被Merge!
|
||||
|
||||
---
|
||||
|
||||
### vn.py项目结构
|
||||
|
||||
1. 丰富的Python交易和数据API接口，基本覆盖了国内外所有常规交易品种（股票、期货、期权、外汇、外盘、比特币），具体包括：
|
||||
|
||||
* CTP（vn.ctp）
|
||||
|
||||
* 飞马（vn.femas）
|
||||
|
||||
* LTS（vn.lts）
|
||||
|
||||
* 金仕达黄金（vn.ksgold）
|
||||
|
||||
* 金仕达期权（vn.ksotp）
|
||||
|
||||
* 飞鼠（vn.sgit）
|
||||
|
||||
* 飞创（vn.xspeed）
|
||||
|
||||
* QDP（vn.qdp）
|
||||
|
||||
* OANDA（vn.oanda）
|
||||
|
||||
* OKCOIN比特币（vn.okcoin）
|
||||
|
||||
* 上海直达期货（vn.shzd）
|
||||
|
||||
* Interactive Brokers（vn.ib目前在开发中）
|
||||
|
||||
* 通联数据（vn.datayes）
|
||||
|
||||
2. 简洁易用的事件驱动引擎（vn.event），作为事件驱动型交易程序的核心
|
||||
|
||||
3. 支持服务器端数据推送的RPC框架（vn.rpc），用于实现多进程分布式架构的交易系统
|
||||
|
||||
3. 针对如何使用API和事件驱动引擎开发交易程序的示例（vn.demo）
|
||||
|
||||
4. 开箱即用的实盘交易平台vn.trader（相比之下vn.demo仅建议学习用），整合了多种交易接口，并针对具体策略算法和功能开发提供了简洁易用的API，功能应用举例：
|
||||
|
||||
* 同时登录多个交易接口，在一套界面上监控多种市场的行情和多种资产账户的资金、持仓、委托、成交情况
|
||||
|
||||
* 支持跨市场套利（CTP期货和LTS证券）、境内外套利（CTP期货和IB外盘）、多市场数据整合实时预测走势（CTP的股指期货数据、IB的外盘A50数据、Wind的行业指数数据）等策略应用
|
||||
|
||||
* CTA策略引擎模块，在保持易用性的同时，允许用户针对CTA类策略运行过程中委托的报撤行为进行细粒度控制（降低交易滑点、实现高频策略）
|
||||
|
||||
5. [官网](http://vnpy.org)和[知乎专栏](http://zhuanlan.zhihu.com/vn-py)，内容目前主要是《Python量化交易平台开发教程系列》，以及vn.py项目进展的更新
|
||||
|
||||
6. 官方交流QQ群262656087，管理较严格（定期清除长期潜水的成员）
|
||||
|
||||
|
||||
---
|
||||
### 联系作者
|
||||
作者知乎名：用python的交易员，想要联系作者可以通过知乎私信
|
||||
|
||||
|
Before Width: | Height: | Size: 382 KiB After Width: | Height: | Size: 382 KiB |
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user