"setuptools-changelog-shortener: add only newest changelog entries to long_description"
Project description
setuptools-changelog-shortener
This setuptools plugin allows shortening the number of changelog entries to use for the long_description metadata in Python packages.
Usage
First, ensure that setuptools_changelog_shortener is present in your build requirements.
# pyproject.toml
[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_changelog_shortener"]
To enable changelog shortening, add the following section to your pyproject.toml:
# pyproject.toml
[tool.setuptools_changelog_shortener]
read_from = "CHANGELOG.rst"
write_to = "CHANGELOG.short.rst"
Then you use the CHANGELOG.short.rst file for your long_description metadata field.
Additional options are:
- count
The number of changelog entries to include. Defaults to 5.
- delimiter
The delimiter to look for in each entry. Defaults to the ^--+ regular expression to find docutils titles using - characters.
- title
The title to add to the top of the shortened CHANGELOG file. Defaults to Changelog\n=========.
Changelog
0.2.0 (unreleased)
Fix error when count is bigger or equal the number of changelog entries.
Add tomli to build requirements.
0.1.0 (2022-02-07)
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for setuptools-changelog-shortener-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff93517a3771836b8e407f3eb52459053ebdb95564f1ed5e6d4ad9c49e369775 |
|
MD5 | c69b9ff10705d72871529f4fed40aa50 |
|
BLAKE2b-256 | e89224e535ad95e9d51ec40286ce75c939c3c87213650720e681500831d2cc75 |
Hashes for setuptools_changelog_shortener-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d51b0288f0fa0a1e36962287d2fef50f50f2423a55442d5bff906f3e1a6976ec |
|
MD5 | 0c1dce11e66cdb719d5e6e4f027c60ef |
|
BLAKE2b-256 | e34c88c45bdc224f130a0c1ed2c8274e586f1d3816f92c830a2cfd66c4231af9 |