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

Development

pip install -e .
python -m pytest tests/ -v

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.6.tar.gz (5.0 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.6-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.6.tar.gz
Algorithm Hash digest
SHA256 196b4c335f101d94a2fc8dda1a50ae2e50a959cc31443df4c4aaf0ae60b26033
MD5 d1b82d789e28a8aa2fad04249b1e6bc0
BLAKE2b-256 ebd3131fe19653da70333f4c3a3b4d4db3f5638e540bc3185aabae672c0bf4c0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ecbdb8f437d424a5c9e3b699eae33973c3bedf8fd2764f3998c063ad7f1d6349
MD5 812beee79d32ab1862f00b648a9192e5
BLAKE2b-256 3fa3ad23a3943fb8a4399c43f157f033b065ad41f703420212d1a51b3cf2b735

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