Tiingo Python 项目教程

1. 项目目录结构及介绍

tiingo-python/
├── docs/
├── examples/
├── tests/
├── tiingo/
├── tools/
├── .editorconfig
├── .gitignore
├── AUTHORS.rst
├── CONTRIBUTING.rst
├── HISTORY.rst
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── RELEASE.rst
├── requirements_dev.txt
├── setup.cfg
├── setup.py
└── tox.ini

目录结构介绍

• docs/: 存放项目的文档文件。
• examples/: 存放项目的示例代码。
• tests/: 存放项目的测试代码。
• tiingo/: 存放项目的主要代码，包括与 Tiingo API 交互的 Python 客户端。
• tools/: 存放项目的工具脚本。
• .editorconfig: 配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• AUTHORS.rst: 项目作者列表。
• CONTRIBUTING.rst: 贡献指南。
• HISTORY.rst: 项目历史记录。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包配置文件。
• Makefile: 项目构建文件。
• README.rst: 项目介绍和使用说明。
• RELEASE.rst: 发布说明。
• requirements_dev.txt: 开发依赖包列表。
• setup.cfg: 项目配置文件。
• setup.py: 项目安装脚本。
• tox.ini: 自动化测试配置文件。

2. 项目启动文件介绍

项目的启动文件主要是 setup.py，它是一个标准的 Python 安装脚本，用于安装和管理项目的依赖包。

setup.py 文件介绍

from setuptools import setup, find_packages

setup(
    name='tiingo',
    version='0.15.6',
    packages=find_packages(),
    install_requires=[
        'requests>=2.20.0',
    ],
    extras_require={
        'pandas': ['pandas>=0.23.0'],
    },
    # 其他配置项...
)

• name: 项目名称。
• version: 项目版本号。
• packages: 需要安装的 Python 包。
• install_requires: 项目的基本依赖包。
• extras_require: 可选依赖包，例如 pandas。

3. 项目的配置文件介绍

项目的配置文件主要是 setup.cfg，它包含了项目的各种配置选项。

setup.cfg 文件介绍

[metadata]
name = tiingo
version = 0.15.6
description = Python client for interacting with the Tiingo Financial Data API (stock ticker and news data)
long_description = file: README.rst
long_description_content_type = text/x-rst
author = Cameron Yick
author_email = [e-mail]
url = https://github.com/hydrosquall/tiingo-python
license = MIT

[options]
packages = find:
install_requires =
    requests>=2.20.0

[options.extras_require]
pandas =
    pandas>=0.23.0

[bdist_wheel]
universal = 1

• [metadata]: 项目元数据，包括项目名称、版本、描述、作者等信息。
• [options]: 安装选项，包括需要安装的包和依赖。
• [options.extras_require]: 可选依赖包的配置。
• [bdist_wheel]: 打包选项，设置为 universal 表示支持 Python 2 和 Python 3。

通过以上配置文件，可以方便地管理和安装 Tiingo Python 项目。