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
Development
pip install -e .
python -m pytest tests/ -v
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file philiprehberger_changelog_gen-0.1.5.tar.gz.
File metadata
- Download URL: philiprehberger_changelog_gen-0.1.5.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b310a543e70a72c42f26c276987550f92cdd38f1c7fc1401d352745259a269b8
|
|
| MD5 |
451b6c51e728c1dac99db209541d203d
|
|
| BLAKE2b-256 |
022e0e3cdd4c7b09db474589c60e39e0e7c6e31657a0c86cbc740656317b82d0
|
File details
Details for the file philiprehberger_changelog_gen-0.1.5-py3-none-any.whl.
File metadata
- Download URL: philiprehberger_changelog_gen-0.1.5-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d63a25436e83143447db546ac44a1b8fb84f379f00de9752a8b57a67440d51f9
|
|
| MD5 |
7e8d8c9d4acafb93953de9febf1791ea
|
|
| BLAKE2b-256 |
afb042a709209a083cb57d5790aaa21fe09a1cfba1b488df493cebf9708c865f
|