JQData SDK 使用教程

JQData SDK 使用教程

jqdatasdk简单易用的量化金融数据包(easy utility for getting financial market data of China)项目地址:https://gitcode.com/gh_mirrors/jq/jqdatasdk

1. 项目的目录结构及介绍

JQData SDK 的目录结构如下：

jqdatasdk/
├── README.md
├── setup.py
├── jqdatasdk/
│   ├── __init__.py
│   ├── auth.py
│   ├── data.py
│   ├── exceptions.py
│   ├── utils.py
│   └── ...
└── tests/
    ├── __init__.py
    ├── test_auth.py
    ├── test_data.py
    └── ...

目录结构介绍

• README.md: 项目说明文档。
• setup.py: 安装脚本。
• jqdatasdk/: 核心代码目录。
  • __init__.py: 模块初始化文件。
  • auth.py: 用户认证相关功能。
  • data.py: 数据获取相关功能。
  • exceptions.py: 自定义异常类。
  • utils.py: 工具函数。
• tests/: 测试代码目录。
  • __init__.py: 测试模块初始化文件。
  • test_auth.py: 用户认证功能测试。
  • test_data.py: 数据获取功能测试。

2. 项目的启动文件介绍

JQData SDK 的启动文件主要是 jqdatasdk/__init__.py。这个文件包含了模块的初始化代码和导出的公共接口。

启动文件内容

from .auth import auth
from .data import get_price, get_fundamentals, ...
from .exceptions import JQDataError
from .utils import ...

# 其他初始化代码

启动文件介绍

• auth: 用户认证函数，用于登录聚宽平台。
• get_price: 获取股票行情数据。
• get_fundamentals: 获取基本面数据。
• JQDataError: 自定义异常类，用于处理数据获取过程中的错误。

3. 项目的配置文件介绍

JQData SDK 的配置文件主要是用户认证信息。用户需要在代码中提供自己的聚宽账号和密码。

配置文件内容

from jqdatasdk import auth

# 用户认证
auth('your_username', 'your_password')

配置文件介绍

• auth: 用户认证函数，需要传入用户名和密码。
• your_username: 聚宽平台的用户名。
• your_password: 聚宽平台的密码。

通过以上配置，用户可以成功登录聚宽平台并获取所需的金融数据。

jqdatasdk简单易用的量化金融数据包(easy utility for getting financial market data of China)项目地址:https://gitcode.com/gh_mirrors/jq/jqdatasdk