Metadata-Version: 2.1
Name: changelog_gen
Version: 0.10.3
Summary: Changelog generation tool
Home-page: https://github.com/NRWLDev/changelog-gen/
License: Apache-2.0
Author: Daniel Edgecombe
Author-email: edgy.edgemond@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: bump-my-version (>=0,<1)
Requires-Dist: gitpython (>=3.1.43,<4.0.0)
Requires-Dist: httpx (>=0,<1)
Requires-Dist: rich (>=13,<14)
Requires-Dist: rtoml (>=0.9)
Requires-Dist: typer (>=0,<1)
Project-URL: Repository, https://github.com/NRWLDev/changelog-gen/
Description-Content-Type: text/markdown

# Changelog Generator - v0.10.3
[![image](https://img.shields.io/pypi/v/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)
[![image](https://img.shields.io/pypi/l/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)
[![image](https://img.shields.io/pypi/pyversions/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)
![style](https://github.com/NRWLDev/changelog-gen/actions/workflows/style.yml/badge.svg)
![tests](https://github.com/NRWLDev/changelog-gen/actions/workflows/tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/NRWLDev/changelog-gen/branch/main/graph/badge.svg)](https://codecov.io/gh/NRWLDev/changelog-gen)

# Details

`changelog-gen` is a CHANGELOG generator intended to be used in conjunction
with [bump-my-version](https://github.com/callowayproject/bump-my-version) to generate
changelogs and create release tags.

See the [docs](https://nrwldev.github.io/changelog-gen) for more details.

## Usage

`changelog init` will generate an empty changelog with `changelog init` if you
have not been maintaining changelogs previously. If you already have a
changelog file, it will be detected.

`changelog generate` will extract all commits matching the conventional format
since the last release, detect the correct semver release, and generate the
correct changelog entry. Depending on configuration, it will also tag the
release.

## Migrating from 0.8 to 0.9 (Conventional Commit support)
Check the discussion
[here](https://github.com/EdgyEdgemond/changelog-gen/discussions/98) for
details on how to update usage to maintain legacy functionality or move over to
new features.

## Installation

```bash
pip install changelog-gen
```

or clone this repo and install with invoke/poetry.

```bash
invoke install-dev
```

## Contributing

This project uses pre-commit hooks, please run `invoke install-dev` after
cloning to install dev dependencies and commit hooks.

