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.3.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.3-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.3.tar.gz
Algorithm Hash digest
SHA256 fb9bc0bfbde3e7607854c3f858674ac598160e9dcf20eb1d6b1f8dd509ceb3e8
MD5 e17a27b4e042454f8c5018f121c3ac94
BLAKE2b-256 25db3454959678da459091ec2c0ab54d7148d2fb6a1d0d3068c95b1b3cc992d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 602fea3d631f448ec437bc8bc8b790e0450e92c3206f4404ceeacaf7fa9800f7
MD5 755b980eef238c4eaf3e40f6bce02d6b
BLAKE2b-256 1f5bb8194e5c30a45694027f4a50423e3e1247aa56d5a5b7178d09f0d006fcde

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