factor_reader
================
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
# 相关链接
- [说明文档](https://chen-001.github.io/factor_reader/)
- [pypi](https://pypi.org/project/factor-reader/)
- [Github](https://github.com/chen-001/factor_reader)
## 安装与升级
- 首次安装
``` sh
pip install factor_reader
```
- 升级
``` sh
pip install factor_reader --upgrade
```
## 使用
factor_reader目前共包含两个功能：
1. 查看目前包含哪些因子，以及每个因子的基本信息
2. 读取某一因子在某段时间上的因子数据
``` python
import factor_reader
# 第一步：实例化一个FactorReader对象，输入token
token='xxxxxxxxxx'
fr=factor_reader.FactorReader(token)
# 第二步：查看当前因子数据库中有哪些因子（此步骤可选）
fr.show_all_factors_information() # 展示所有可读取因子的相关信息
# 第三步：读取因子数据
## ①读取单日单个因子的数据
fr.read_factor('球队硬币',trade_date=20230113) # 读取球队硬币因子在2023年1月13日的因子数据
fr.read_factor('factor4',trade_date=20230113) # 读取方正金工多因子系列第4篇的因子在2023年1月13日的因子数据
## ②读取多个交易日单个因子的数据
fr.read_factor('球队硬币',start_date=20230101,end_date=20230113) # 读取球队硬币因子从2023年1月1日至2023年1月13日的因子数据
fr.read_factor('factor4',start_date=20230101,end_date=20230113,sql_like=True) # 以sql的形式，读取方正金工多因子系列第4篇的因子从2023年1月1日至2023年1月13日的因子数据
## ③读取多个交易日多个因子的因子数据
fr.read_factor(['球队硬币','云开雾散'],start_date=20230101,end_date=20230113) # 分别读取球队硬币因子和云开雾散因子从2023年1月1日至2023年1月13日的因子数据
fr.read_factor(['球队硬币','云开雾散','飞蛾扑火'],start_date=20230101,end_date=20230113,sql_like=True) # 以sql的形式，分别读取球队硬币因子、云开雾散因子、飞蛾扑火因子从2023年1月1日至2023年1月13日的因子数据
fr.read_factor(['球队硬币','云开雾散','飞蛾扑火'],trade_date=20230113,sql_like=True) # 以sql的形式，分别读取球队硬币因子、云开雾散因子、飞蛾扑火因子2023年1月13日的因子数据
```
Raw data
{
"_id": null,
"home_page": "https://github.com/chen-001/factor_reader",
"name": "factor-reader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "chenzongwei",
"author_email": "winterwinter999@163.com",
"download_url": "https://files.pythonhosted.org/packages/0f/b7/d677e5228fcefacf2e87161347c48cb45d879519bbe0f2e134392e41533d/factor_reader-1.0.5.tar.gz",
"platform": null,
"description": "factor_reader\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n# \u76f8\u5173\u94fe\u63a5\n\n- [\u8bf4\u660e\u6587\u6863](https://chen-001.github.io/factor_reader/)\n- [pypi](https://pypi.org/project/factor-reader/)\n- [Github](https://github.com/chen-001/factor_reader)\n\n## \u5b89\u88c5\u4e0e\u5347\u7ea7\n\n- \u9996\u6b21\u5b89\u88c5\n\n``` sh\npip install factor_reader\n```\n\n- \u5347\u7ea7\n\n``` sh\npip install factor_reader --upgrade\n```\n\n## \u4f7f\u7528\n\nfactor_reader\u76ee\u524d\u5171\u5305\u542b\u4e24\u4e2a\u529f\u80fd\uff1a \n1. \u67e5\u770b\u76ee\u524d\u5305\u542b\u54ea\u4e9b\u56e0\u5b50\uff0c\u4ee5\u53ca\u6bcf\u4e2a\u56e0\u5b50\u7684\u57fa\u672c\u4fe1\u606f \n2. \u8bfb\u53d6\u67d0\u4e00\u56e0\u5b50\u5728\u67d0\u6bb5\u65f6\u95f4\u4e0a\u7684\u56e0\u5b50\u6570\u636e\n\n``` python\nimport factor_reader\n\n# \u7b2c\u4e00\u6b65\uff1a\u5b9e\u4f8b\u5316\u4e00\u4e2aFactorReader\u5bf9\u8c61\uff0c\u8f93\u5165token\ntoken='xxxxxxxxxx'\nfr=factor_reader.FactorReader(token) \n\n# \u7b2c\u4e8c\u6b65\uff1a\u67e5\u770b\u5f53\u524d\u56e0\u5b50\u6570\u636e\u5e93\u4e2d\u6709\u54ea\u4e9b\u56e0\u5b50\uff08\u6b64\u6b65\u9aa4\u53ef\u9009\uff09\nfr.show_all_factors_information() # \u5c55\u793a\u6240\u6709\u53ef\u8bfb\u53d6\u56e0\u5b50\u7684\u76f8\u5173\u4fe1\u606f\n\n# \u7b2c\u4e09\u6b65\uff1a\u8bfb\u53d6\u56e0\u5b50\u6570\u636e\n## \u2460\u8bfb\u53d6\u5355\u65e5\u5355\u4e2a\u56e0\u5b50\u7684\u6570\u636e\nfr.read_factor('\u7403\u961f\u786c\u5e01',trade_date=20230113) # \u8bfb\u53d6\u7403\u961f\u786c\u5e01\u56e0\u5b50\u57282023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\nfr.read_factor('factor4',trade_date=20230113) # \u8bfb\u53d6\u65b9\u6b63\u91d1\u5de5\u591a\u56e0\u5b50\u7cfb\u5217\u7b2c4\u7bc7\u7684\u56e0\u5b50\u57282023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\n\n## \u2461\u8bfb\u53d6\u591a\u4e2a\u4ea4\u6613\u65e5\u5355\u4e2a\u56e0\u5b50\u7684\u6570\u636e\nfr.read_factor('\u7403\u961f\u786c\u5e01',start_date=20230101,end_date=20230113) # \u8bfb\u53d6\u7403\u961f\u786c\u5e01\u56e0\u5b50\u4ece2023\u5e741\u67081\u65e5\u81f32023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\nfr.read_factor('factor4',start_date=20230101,end_date=20230113,sql_like=True) # \u4ee5sql\u7684\u5f62\u5f0f\uff0c\u8bfb\u53d6\u65b9\u6b63\u91d1\u5de5\u591a\u56e0\u5b50\u7cfb\u5217\u7b2c4\u7bc7\u7684\u56e0\u5b50\u4ece2023\u5e741\u67081\u65e5\u81f32023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\n\n## \u2462\u8bfb\u53d6\u591a\u4e2a\u4ea4\u6613\u65e5\u591a\u4e2a\u56e0\u5b50\u7684\u56e0\u5b50\u6570\u636e\nfr.read_factor(['\u7403\u961f\u786c\u5e01','\u4e91\u5f00\u96fe\u6563'],start_date=20230101,end_date=20230113) # \u5206\u522b\u8bfb\u53d6\u7403\u961f\u786c\u5e01\u56e0\u5b50\u548c\u4e91\u5f00\u96fe\u6563\u56e0\u5b50\u4ece2023\u5e741\u67081\u65e5\u81f32023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\nfr.read_factor(['\u7403\u961f\u786c\u5e01','\u4e91\u5f00\u96fe\u6563','\u98de\u86fe\u6251\u706b'],start_date=20230101,end_date=20230113,sql_like=True) # \u4ee5sql\u7684\u5f62\u5f0f\uff0c\u5206\u522b\u8bfb\u53d6\u7403\u961f\u786c\u5e01\u56e0\u5b50\u3001\u4e91\u5f00\u96fe\u6563\u56e0\u5b50\u3001\u98de\u86fe\u6251\u706b\u56e0\u5b50\u4ece2023\u5e741\u67081\u65e5\u81f32023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\nfr.read_factor(['\u7403\u961f\u786c\u5e01','\u4e91\u5f00\u96fe\u6563','\u98de\u86fe\u6251\u706b'],trade_date=20230113,sql_like=True) # \u4ee5sql\u7684\u5f62\u5f0f\uff0c\u5206\u522b\u8bfb\u53d6\u7403\u961f\u786c\u5e01\u56e0\u5b50\u3001\u4e91\u5f00\u96fe\u6563\u56e0\u5b50\u3001\u98de\u86fe\u6251\u706b\u56e0\u5b502023\u5e741\u670813\u65e5\u7684\u56e0\u5b50\u6570\u636e\n```\n\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "a tool to read stock factor data for quants",
"version": "1.0.5",
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a41ab97475cd83ba0dc9e36b824e00c8f17e6d0c8e80860ea2553fd51789c855",
"md5": "5d0f76931c0d649e0ce0992a073d5f97",
"sha256": "f8f043759e51a355b7f0611d0a0ec24bd25e4c31ccf486ea4241cb6d44596348"
},
"downloads": -1,
"filename": "factor_reader-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d0f76931c0d649e0ce0992a073d5f97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 11702,
"upload_time": "2023-03-10T12:31:12",
"upload_time_iso_8601": "2023-03-10T12:31:12.262054Z",
"url": "https://files.pythonhosted.org/packages/a4/1a/b97475cd83ba0dc9e36b824e00c8f17e6d0c8e80860ea2553fd51789c855/factor_reader-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fb7d677e5228fcefacf2e87161347c48cb45d879519bbe0f2e134392e41533d",
"md5": "d99cfb4c3dd5624ee47135133c3f257a",
"sha256": "57cda03ecaa6cd29813702ded17d979b46b6b805c2bf070137d7524bdf30774a"
},
"downloads": -1,
"filename": "factor_reader-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d99cfb4c3dd5624ee47135133c3f257a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 29915,
"upload_time": "2023-03-10T12:31:14",
"upload_time_iso_8601": "2023-03-10T12:31:14.905465Z",
"url": "https://files.pythonhosted.org/packages/0f/b7/d677e5228fcefacf2e87161347c48cb45d879519bbe0f2e134392e41533d/factor_reader-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-10 12:31:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "chen-001",
"github_project": "factor_reader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "factor-reader"
}
JSON
