Python 项目模板使用指南

1. 项目目录结构及介绍

template-python/
├── .github/
│   └── workflows/
│       └── tests.yml
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
├── setup.cfg
├── src/
│   └── project_name/
│       ├── __init__.py
│       ├── cli.py
│       ├── settings.py
│       └── version.py
└── tests/
    ├── __init__.py
    └── test_cli.py

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化测试和部署。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档，通常包含项目的基本信息、安装步骤和使用说明。
• pyproject.toml: 项目的配置文件，用于定义项目的构建系统和依赖。
• setup.cfg: 项目的配置文件，用于定义项目的元数据和安装选项。
• src/project_name/: 项目的源代码目录，包含项目的核心代码。
  • init.py: 使目录成为一个 Python 包。
  • cli.py: 命令行接口的实现文件。
  • settings.py: 项目的配置文件，包含项目的全局配置。
  • version.py: 定义项目的版本号。
• tests/: 包含项目的测试代码。
  • init.py: 使目录成为一个 Python 包。
  • test_cli.py: 命令行接口的测试文件。

2. 项目启动文件介绍

项目的启动文件是 src/project_name/cli.py。该文件定义了项目的命令行接口，用户可以通过命令行执行项目的功能。

示例代码

import click

@click.command()
@click.option('--name', prompt='Your name', help='The person to greet.')
def greet(name):
    """Simple program that greets NAME for a total of COUNT times."""
    click.echo(f'Hello, {name}!')

if __name__ == '__main__':
    greet()

启动方式

在项目根目录下，可以通过以下命令启动项目：

python -m src.project_name.cli

3. 项目的配置文件介绍

项目的配置文件主要有两个：pyproject.toml 和 setup.cfg。

pyproject.toml

pyproject.toml 文件定义了项目的构建系统和依赖。以下是一个示例：

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

[project]
name = "project_name"
version = "0.1.0"
description = "A template for Python projects"
authors = [
    { name="Jace Browning", email="[e-mail]" },
]
dependencies = [
    "click>=7.0",
]

setup.cfg

setup.cfg 文件定义了项目的元数据和安装选项。以下是一个示例：

[metadata]
name = project_name
version = 0.1.0
description = A template for Python projects
author = Jace Browning
author_email = [e-mail]
license = MIT

[options]
packages = find:
install_requires =
    click>=7.0

[options.entry_points]
console_scripts =
    project_name = project_name.cli:greet

配置文件的作用

• pyproject.toml: 定义了项目的构建系统和依赖，确保项目能够正确构建和安装。
• setup.cfg: 定义了项目的元数据和安装选项，确保项目能够正确安装和运行。

通过以上配置文件，用户可以轻松地安装和运行项目，并根据需要进行自定义配置。