Skip to main content

Simple tool to generate nice, formatted changelogs from vcs

Project description

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 --dev

To activate virtualenv:

poetry shell

To run tests:

pytest

For consistent formatting, you may use Black:

black .

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

auto-changelog-0.3.0.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

auto_changelog-0.3.0-py3-none-any.whl (9.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page