setuptools-changelog-shortener 0.2.0

用法

首先，确保 setuptools_changelog_shortener 包含在您的构建需求中。

# pyproject.toml
[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_changelog_shortener"]

要启用变更日志缩短，请将以下部分添加到您的 pyproject.toml

# pyproject.toml
[tool.setuptools_changelog_shortener]
read_from = "CHANGELOG.rst"
write_to = "CHANGELOG.short.rst"

然后您可以使用 CHANGELOG.short.rst 文件来为您的 long_description 元数据字段。

其他选项包括

count

要包含的变更日志条目数。默认为 5。

delimiter

要查找每个条目中的分隔符。默认为 ^--+ 正则表达式，使用 - 字符查找docutils标题。

title

要将到缩短的CHANGELOG文件顶部的标题。默认为 Changelog\n=========。

0.2.0 (未发布)

• 修复当 count 大于或等于变更日志条目数时的错误。

• 将 tomli 添加到构建需求。

0.1.0 (2022-02-07)

• 初始发布。