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 details)

Uploaded Source

File details

Details for the file changelogmd-0.2.0.tar.gz.

File metadata

  • Download URL: changelogmd-0.2.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

File hashes

Hashes for changelogmd-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e53ac7b6a24c60a683ddaafd25019c60f07f066d7ae1495df93c75099ef8b53b
MD5 5620836240375291f782e80cdd5462eb
BLAKE2b-256 3b440c129b14c7419c8588eb28daf968349dbfc34a7f006d518689554083be7a

See more details on using hashes here.

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