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.1.tar.gz (4.7 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.1-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2d4ef57678dcbb8f85ca6e6a8ca574ce6069a1ef4e7482a9d67c1daa5e6f688f
MD5 d74a269324bc7636d6ddcdc34ba50a7d
BLAKE2b-256 8299e82bfb80074828caf13bd71afddc393f05e77a3fbfe1e3088d78e37d1ffb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82083365ba14ba7374e9580dd41c667650d11c7ca3dc4e0aa6620f902415500a
MD5 0a033b46e84cae25b36876d8bca65d22
BLAKE2b-256 509dd231e99d855f3c602773d72ec927463a1e6b2f7519c3f7a6f87118e597ec

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