Skip to main content

Git-based changelog generator from conventional commits

Project description

philiprehberger-changelog-gen

Tests PyPI version License

Git-based changelog generator from conventional commits.

Install

pip install philiprehberger-changelog-gen

Usage

Python API

from philiprehberger_changelog_gen import generate_changelog

changelog = generate_changelog(
    repo_path=".",
    from_tag="v0.1.0",
    version="0.2.0",
)

# Print markdown
print(changelog.to_markdown())

# Write to file (prepend to existing)
changelog.write("CHANGELOG.md", mode="prepend")

CLI

# Print to stdout
changelog-gen

# From a specific tag
changelog-gen --from v0.1.0 --version 0.2.0

# Write to file
changelog-gen --output CHANGELOG.md --prepend

Conventional Commits

The generator parses conventional commit messages:

feat: add user authentication
fix(auth): handle expired tokens
feat!: redesign API (breaking change)
chore: update dependencies

Commits are grouped by type: Features, Bug Fixes, Performance, Refactoring, Documentation, Tests, Chores, CI/CD, Build, Style.

Output Example

## 0.2.0 (2026-03-10)

### Breaking Changes

- **api:** redesign authentication flow

### Features

- add user dashboard
- **auth:** add OAuth2 support

### Bug Fixes

- **db:** fix connection pool leak

License

MIT

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

philiprehberger_changelog_gen-0.1.4.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_changelog_gen-0.1.4-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_changelog_gen-0.1.4.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8bd87ca3855842c44e2878ce837bdc493bc2cd23d7bd167fed083a2843650a5e
MD5 d5be67e9aba11059492548f9c3bce750
BLAKE2b-256 34965fed70c38f6c49f453f413d2db679bd60d7f2c41f934f3c767138ca3525a

See more details on using hashes here.

File details

Details for the file philiprehberger_changelog_gen-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6c262ab58076d86e8b2e53839596ab5b19f0c2fb9000772ed2e485df61a05740
MD5 638c7765fa9e1185a0c48b256c33623e
BLAKE2b-256 cafc2e89ef51411230745f5313ee855cea8a1afa70d2977d09e8a1273db12229

See more details on using hashes here.

Supported by

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