Skip to main content

Python module and CLI tool for CHANGELOG.md manipulation.

Project description

py-changelogmd

Python module and CLI tool for CHANGELOG.md manipulation.

Install

python3 -m pip install changelogmd

Usage

from changelogmd import Changelog
changelog = Changelog("CHANGELOG.md")

# List available versions
print(list(changelog.versions))

# Print full Markdown
print(str(changelog))

# Print full Markdown of latest version
print(str(changelog.versions[0]))

# Bump release version from UNRELEASED version
changelog.bump()

UNRELEASED changes

Unreleased changes are stored in the CHANGELOG.md file as top-most version

# Changelog

## [UNRELEASED]

### Added
- New Feature added

### Removed
- This will cause a minor version bump

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelogmd-0.2.0.tar.gz (4.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page