setup-cfg-fmt 项目教程

setup-cfg-fmt 项目教程

setup-cfg-fmtapply a consistent format to `setup.cfg` files项目地址:https://gitcode.com/gh_mirrors/se/setup-cfg-fmt

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

setup-cfg-fmt/
├── github/
│   └── workflows/
│       └── tests
├── .gitignore
├── pre-commit-config.yaml
├── pre-commit-hooks.yaml
├── LICENSE
├── README.md
├── requirements-dev.txt
├── setup.cfg
├── setup.py
├── setup_cfg_fmt.py
└── tox.ini

• github/workflows/: 包含项目的CI/CD配置文件。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• pre-commit-config.yaml: 配置pre-commit钩子。
• pre-commit-hooks.yaml: 配置pre-commit钩子。
• LICENSE: 项目的MIT许可证文件。
• README.md: 项目说明文档。
• requirements-dev.txt: 开发依赖文件。
• setup.cfg: 项目的配置文件。
• setup.py: 项目的安装脚本。
• setup_cfg_fmt.py: 项目的主要执行文件。
• tox.ini: 配置tox自动化测试工具。

2. 项目的启动文件介绍

setup_cfg_fmt.py 是项目的主要执行文件，负责格式化 setup.cfg 文件。可以通过以下命令运行：

$ setup-cfg-fmt --help

该文件的主要功能包括：

• 设置属性的统一顺序。
• 将连字符转换为下划线。
• 规范化项目名称。
• 添加 long_description 和 long_description_content_type。
• 添加 license_file 和 license 分类器。

3. 项目的配置文件介绍

setup.cfg 是项目的主要配置文件，包含了项目的元数据和选项配置。以下是一些关键配置项的介绍：

[metadata]
name = pre_commit
version = 1.14.5
classifiers =
    Programming Language :: Python :: 3
    License :: OSI Approved :: MIT License

[options]
dependency_links =
python_requires = >=3.6.1

• [metadata] 部分包含项目的元数据，如 name、version 和 classifiers。
• [options] 部分包含项目的选项配置，如 dependency_links 和 python_requires。

通过 setup-cfg-fmt 工具，可以确保 setup.cfg 文件的格式一致性，便于维护和上传到 PyPI。

setup-cfg-fmtapply a consistent format to `setup.cfg` files项目地址:https://gitcode.com/gh_mirrors/se/setup-cfg-fmt