pytickersymbols 项目使用教程

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

pytickersymbols 项目的目录结构如下：

pytickersymbols/
├── src/
│   └── pytickersymbols/
│       ├── __init__.py
│       └── ...
├── tests/
│   └── ...
├── tools/
│   └── ...
├── .coveragerc
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── poetry.lock
├── pyproject.toml
└── stocks.yaml

目录结构介绍：

• src/pytickersymbols/: 包含项目的主要源代码文件。
• tests/: 包含项目的测试代码文件。
• tools/: 包含项目的工具脚本文件。
• .coveragerc: 配置代码覆盖率测试的文件。
• .gitignore: 配置 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文件。
• poetry.lock: 锁定项目依赖版本的文件。
• pyproject.toml: 项目的配置文件，包含项目的基本信息和依赖配置。
• stocks.yaml: 包含股票数据的配置文件。

2. 项目的启动文件介绍

pytickersymbols 项目的启动文件是 src/pytickersymbols/__init__.py。该文件是项目的入口文件，包含了项目的初始化代码和主要功能模块的导入。

启动文件内容概述：

• 初始化代码: 初始化项目的基本配置和环境。
• 功能模块导入: 导入项目中各个功能模块，确保项目能够正常运行。

3. 项目的配置文件介绍

pytickersymbols 项目的主要配置文件是 pyproject.toml 和 stocks.yaml。

pyproject.toml

pyproject.toml 是项目的配置文件，包含了项目的基本信息和依赖配置。以下是该文件的主要内容：

[tool.poetry]
name = "pytickersymbols"
version = "1.0.0"
description = "Fundamental stock data and yahoo/google ticker symbols for several indices"
authors = ["Your Name <[e-mail]>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.7"
requests = "^2.25.1"

[tool.poetry.dev-dependencies]
pytest = "^6.2.2"

配置文件内容介绍：

• [tool.poetry]: 定义项目的基本信息，如项目名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 定义项目的依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 定义开发环境下的依赖包及其版本要求。

stocks.yaml

stocks.yaml 是项目的股票数据配置文件，包含了多个指数的股票数据。以下是该文件的部分内容：

indices:
  - name: "AEX"
    stocks:
      - name: "Company A"
        ticker: "A"
      - name: "Company B"
        ticker: "B"
  - name: "BEL 20"
    stocks:
      - name: "Company C"
        ticker: "C"
      - name: "Company D"
        ticker: "D"

配置文件内容介绍：

• indices: 定义多个指数及其包含的股票数据。
• stocks: 定义每个指数中的股票名称和对应的 ticker 符号。

通过以上配置文件，项目能够获取并处理不同指数的股票数据，为用户提供便捷的股票信息查询功能。