PyTMDB3 项目使用教程

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

PyTMDB3 项目的目录结构如下：

pytmdb3/
├── scripts/
├── tests/
├── tmdb3/
│   ├── __init__.py
│   ├── tmdb_api.py
│   └── ...
├── .coveragerc
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── pyproject.toml
├── pytest.ini
├── requirements-dev.txt
├── requirements.txt
├── setup.py
└── tox.ini

目录结构介绍

• scripts/: 包含项目的脚本文件。
• tests/: 包含项目的测试文件。
• tmdb3/: 核心代码目录，包含 API 接口实现文件。
  • __init__.py: 模块初始化文件。
  • tmdb_api.py: 主要 API 接口实现文件。
• .coveragerc: 代码覆盖率配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• README.md: 项目说明文档。
• pyproject.toml: 项目配置文件。
• pytest.ini: pytest 配置文件。
• requirements-dev.txt: 开发依赖文件。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。
• tox.ini: tox 配置文件。

2. 项目的启动文件介绍

PyTMDB3 项目的启动文件是 setup.py。该文件负责项目的安装和打包。通过运行以下命令可以安装项目：

pip install .

setup.py 文件内容简介

setup.py 文件主要包含以下内容：

• 项目元数据（如名称、版本、作者等）。
• 依赖项列表。
• 安装脚本。

3. 项目的配置文件介绍

PyTMDB3 项目的配置文件主要包括以下几个：

• pyproject.toml: 项目配置文件，包含构建系统的要求和其他配置。
• pytest.ini: pytest 配置文件，用于配置测试运行时的参数。
• tox.ini: tox 配置文件，用于自动化测试和环境管理。
• requirements.txt: 项目依赖文件，列出了项目运行所需的 Python 包。
• requirements-dev.txt: 开发依赖文件，列出了开发和测试所需的额外 Python 包。

配置文件内容简介

• pyproject.toml:

  [build-system]
  requires = ["setuptools", "wheel"]
  build-backend = "setuptools.build_meta"
  

• pytest.ini:

  [pytest]
  addopts = --cov=tmdb3 --cov-report=term-missing
  

• tox.ini:

  [tox]
  envlist = py36,py37,py38
  skipsdist = true
  
  [testenv]
  deps =
      -rrequirements.txt
      -rrequirements-dev.txt
  commands = pytest
  

• requirements.txt:

  requests>=2.24.0
  

• requirements-dev.txt:

  pytest>=6.0.0
  pytest-cov>=2.10.0
  

通过这些配置文件，可以确保项目在不同环境和场景下的正确运行和测试。