Simple tool to generate nice, formatted changelogs from vcs


Keywords
git, changelog
License
MIT
Install
pip install auto-changelog==0.5.1

Documentation

Auto Changelog

CI Pipeline PyPI PyPI - Python Version PyPI - License Code style - Black

A quick script that will generate a changelog for any git repository using conventional style commit messages.

Installation

Install and update using pip:

pip install auto-changelog

or directly from source(via poetry):

poetry install
poetry build
pip install dist/*.whl

A simple example

Example usage of auto-changelog

Contributing

To setup development environment, you may use Poetry:

poetry install

To activate virtualenv:

poetry shell

To run tests:

pytest

For consistent formatting, you may use Black:

black .

Note

Instead of manual run of black tool, you can consider using Pre-commit.