Skip to main content

Git-based changelog generator from conventional commits

Project description

philiprehberger-changelog-gen

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.0.tar.gz (4.6 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.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f1092314da687b25bcc286e0bad3b2308f5d9fc3a612f865fa2b8ed9c70fbe69
MD5 fc89b05ec9be39f40cf392ba0c0d0bd0
BLAKE2b-256 068a53ad899e0485c02939292f6411fc04682530bf5070de2cd87fb901aa86a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c4ad77fbd438c1b519543d4261ccb169b51a186852139aba09f904b65cc7d65a
MD5 3e50a99c2fab5ba8987ed3b5820d3c8a
BLAKE2b-256 ed29424d4b5993be3490b7c9bd5a66337e179209d805ddf97086fd95cd17850b

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