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.
1 maintainer
Metadata
1 maintainer
Release files for setuptools-changelog-shortener 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| setuptools-changelog-shortener-0.2.0.tar.gz | 3.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| setuptools_changelog_shortener-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.8 kB
Release files / setuptools-changelog-shortener-0.2.0.tar.gz
| Download URL | setuptools-changelog-shortener-0.2.0.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff93517a3771836b8e407f3eb52459053ebdb95564f1ed5e6d4ad9c49e369775
|
|
BLAKE2b-256 checksum How to use checksums |
e89224e535ad95e9d51ec40286ce75c939c3c87213650720e681500831d2cc75
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
devpi-server/6.1.0 (py3.8.6; darwin)
|
Release files / setuptools_changelog_shortener-0.2.0-py3-none-any.whl
| Download URL | setuptools_changelog_shortener-0.2.0-py3-none-any.whl |
|---|---|
| Size | 4.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d51b0288f0fa0a1e36962287d2fef50f50f2423a55442d5bff906f3e1a6976ec
|
|
BLAKE2b-256 checksum How to use checksums |
e34c88c45bdc224f130a0c1ed2c8274e586f1d3816f92c830a2cfd66c4231af9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
devpi-server/6.1.0 (py3.8.6; darwin)
|
Security for setuptools-changelog-shortener 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
