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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b310a543e70a72c42f26c276987550f92cdd38f1c7fc1401d352745259a269b8
MD5 451b6c51e728c1dac99db209541d203d
BLAKE2b-256 022e0e3cdd4c7b09db474589c60e39e0e7c6e31657a0c86cbc740656317b82d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_changelog_gen-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d63a25436e83143447db546ac44a1b8fb84f379f00de9752a8b57a67440d51f9
MD5 7e8d8c9d4acafb93953de9febf1791ea
BLAKE2b-256 afb042a709209a083cb57d5790aaa21fe09a1cfba1b488df493cebf9708c865f

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