Metadata-Version: 2.1
Name: factor-reader
Version: 0.0.4
Summary: a tool to read stock factor data for quants
Home-page: https://github.com/chen-001/factor_reader
Author: chenzongwei
Author-email: winterwinter999@163.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

factor_reader
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

# 相关链接

- [说明文档](https://chen-001.github.io/factor_reader/)
- [pypi](https://pypi.org/project/factor-reader/)

## 安装

``` sh
pip install factor_reader
```

## 使用

factor_reader目前共包含两个功能：  
1. 查看目前包含哪些因子，以及每个因子的基本信息  
2. 读取某一因子在某段时间上的因子数据

第一步：查看目前数据库中有哪些因子

``` python
import factor_reader

# 需要token请与作者联系
token='xxxxxxxxxx'  
info=factor_reader.show_all_factors_information(token)
```

第二步：读取某个因子在某个时间段的数据

``` python
import factor_reader

# 需要token请与作者联系
token='xxxxxxxxxx' 

# 读取键名为factor1的因子在2013年1月1日至2022年12月31日间的因子数据
data1=factor_reader.read_factor('factor1',token=token,start_date=20130101,end_date=20221231) 

# 读取键名为factor4的因子在2023年1月13日的因子数据
data2=factor_reader.read_factor('factor4',token=token,trade_date=20230113) 

# 读取键名为factor5的因子全部的因子数据
data3=factor_reader.read_factor('factor5',token=token) 
```


