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 .

Note

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for auto-changelog, version 0.3.0rc1
Filename, size File type Python version Upload date Hashes
Filename, size auto_changelog-0.3.0rc1-py3-none-any.whl (9.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size auto-changelog-0.3.0rc1.tar.gz (8.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page