"setuptools-changelog-shortener: add only newest changelog entries to long_description"
Project description
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=========.
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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cdc4cf959aaa327033c27ff04b17490e2037e3d020f09cba874441b06bce201 |
|
MD5 | c9248945a480ca2ada88ba88b5d105ae |
|
BLAKE2b-256 | 82e2122f71aeeeaedeb58645c68ade250a9fb17bf298ab0377abe4936d0fc1a1 |
Hashes for setuptools_changelog_shortener-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4997ff35c8c6235343385e7a2877e31542b1fca0c725ffea544092e40c0696aa |
|
MD5 | ca3e1d67299ae609bacda3630853915c |
|
BLAKE2b-256 | be39870efa8523b0e815c7e155eceefbe6d8a5d2fa16dfd8db6ed05d532209e2 |