StockStats 项目使用文档

1. 项目目录结构及介绍

stockstats/
├── github/
│   └── workflows/
│       └── test_data/
├── .gitignore
├── LICENSE.txt
├── MANIFEST.in
├── README.md
├── requirements.txt
├── setup.cfg
├── setup.py
├── stockstats.py
├── test-requirements.txt
├── test.py
└── tox.ini

目录结构介绍

• github/workflows/test_data/: 包含测试数据的目录。
• .gitignore: Git 忽略文件配置。
• LICENSE.txt: 项目许可证文件。
• MANIFEST.in: 用于打包项目的配置文件。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖库列表。
• setup.cfg: 项目安装配置文件。
• setup.py: 项目安装脚本。
• stockstats.py: 项目核心代码文件，包含 StockDataFrame 类。
• test-requirements.txt: 测试依赖库列表。
• test.py: 项目测试脚本。
• tox.ini: 用于自动化测试的配置文件。

2. 项目启动文件介绍

stockstats.py

stockstats.py 是 StockStats 项目的核心文件，包含了 StockDataFrame 类的定义。StockDataFrame 是一个基于 pandas.DataFrame 的包装类，提供了内联的股票统计/指标支持。

主要功能

• 初始化: 通过 wrap 或 StockDataFrame.retype 方法初始化 StockDataFrame。
• 统计/指标支持: 支持多种股票统计和指标计算，如 SMA、EMA、RSI、MACD 等。
• 数据访问: 允许用户通过指定列名直接访问统计结果。

示例代码

import pandas as pd
from stockstats import wrap

# 读取CSV文件
data = pd.read_csv('stock.csv')

# 初始化 StockDataFrame
df = wrap(data)

# 访问统计结果
macd = df['macd']
rsi = df['rsi']

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是项目的安装配置文件，用于指定项目的元数据和安装选项。

主要配置项

• metadata: 包含项目名称、版本、作者等信息。
• options: 指定安装选项，如依赖库、包文件等。

requirements.txt

requirements.txt 列出了项目运行所需的依赖库及其版本。

示例内容

pandas>=1.0.0
numpy>=1.18.0

test-requirements.txt

test-requirements.txt 列出了项目测试所需的依赖库及其版本。

示例内容

pytest>=6.0.0

tox.ini

tox.ini 是用于自动化测试的配置文件，定义了测试环境和测试命令。

主要配置项

• envlist: 定义测试环境列表。
• commands: 指定测试命令。

示例内容

[tox]
envlist = py36, py37, py38

[testenv]
deps =
    pytest
commands =
    pytest

通过以上配置文件，可以确保项目在不同环境下的一致性和可重复性测试。