internal/tools/: setuptools-changelog-shortener-0.2.0 metadata and description

Homepage Simple index

"setuptools-changelog-shortener: add only newest changelog entries to long_description"

author Florian Schulze
author_email mail@florian-schulze.net
classifiers
  • Development Status :: 4 - Beta
  • Intended Audience :: Developers
  • License :: OSI Approved :: MIT License
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: 3 :: Only
  • Programming Language :: Python :: 3.6
  • Programming Language :: Python :: 3.7
  • Programming Language :: Python :: 3.8
  • Programming Language :: Python :: 3.9
  • Topic :: System :: Software Distribution
  • Topic :: Utilities
description_content_type text/x-rst
license MIT
platform
  • UNKNOWN
project_urls
  • Bug Tracker, https://github.com/fschulze/setuptools-changelog-shortener/issues
  • Source Code, https://github.com/fschulze/setuptools-changelog-shortener
requires_dist
  • setuptools >=45
  • tomli >=1.0
requires_python >=3.6
File Tox results History
setuptools-changelog-shortener-0.2.0.tar.gz
Size
3 KB
Type
Source
setuptools_changelog_shortener-0.2.0-py3-none-any.whl
Size
4 KB
Type
Python Wheel
Python
3

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.