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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4da8140544078103db820e84f2a975087ec0d4f9c038679e4d2af8811ee43d79
MD5 76e6c3957355888f909ff00e9a5aada0
BLAKE2b-256 465cfe1825747d568e70fd05e25290b3c1dec0c67ac3946d1e664a630d4cd4ac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f35b8b0b9f5250da67d3b16e2954e28398bff9e591c2558350530d4c3101248
MD5 73efa696efbd4878bb741fd0865c1dd4
BLAKE2b-256 f0f5532640b059ed2766151386720856aaf44c449a97ca75bc414321d4b3275d

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