Setup-cfg-fmt: 一致性配置文件格式化工具
1. 项目基础介绍
setup-cfg-fmt
是一个开源项目,主要使用 Python 编程语言开发。该项目旨在为 setup.cfg
文件提供一致性格式化处理,使得配置文件更加规范和易于管理。
2. 核心功能
- 属性排序:
setup-cfg-fmt
会为setup.cfg
文件中的属性设置一致的排序规则,例如将最重要的元数据如name
和version
置于顶部。 - 命名规范:该工具能够将项目名称中的破折号(dashes)转换为下划线(underscores),以符合
pip
的命名规范。 - 自动添加元数据:如果项目包含
README.md
文件,setup-cfg-fmt
会自动添加long_description
和long_description_content_type
字段。 - 许可证信息:如果项目中包含
LICENSE
文件,工具将自动添加license
和license_file
字段,以及相应的classifiers
。
3. 最近更新的功能
- 许可证分类器:最新版本中添加了根据
LICENSE
文件自动设置license
、license_file
和classifiers
的功能。 - Python 版本分类器:项目现在可以根据
python_requires
、tox.ini
中的envlist
、已设置的 Python 版本分类器和--min-py-version
参数来生成 Python 版本分类器。 - 分类器排序和清理:新版本还包含了对分类器的排序和移除空白选项的功能。
通过这些更新,setup-cfg-fmt
进一步提高了配置文件的一致性和可读性,有助于开源项目的维护和发布。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考