Metadata-Version: 2.1
Name: logchange
Version: 0.1.2rc2
Summary: Keep-a-changelog manager
Home-page: https://github.com/vemel/logchange
License: MIT
Keywords: version,pep440
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
Requires-Python: >=3.6.10,<4.0.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: newversion (>=1.6.0,<2.0.0)
Requires-Dist: typing-extensions (>=3.7.4,<4.0.0)
Project-URL: Documentation, https://logchange.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/logchange
Project-URL: Tracker, https://github.com/vemel/logchange/issues
Description-Content-Type: text/markdown

# logchange - Changelog manager

View, update and format your changelog anywhere!

## Features

- Keeps your changelog in [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) style
- Supports version bumping from [semver](https://pypi.org/project/semver/)
- Comes with a CLI tool `logchange`
- Respects MarkDown
- Created for CI and scripts

## Installation

```bash
python -m pip install logchange
```

## Usage

### CLI

See [examples/cli.sh](https://github.com/vemel/logchange/tree/main/examples/cli.sh) folder.

```bash
# create CHANGELOG.md if it does not exist
# or reformat existing (please check changes manually)
logchange init -f

# add new release
cat NOTES_0.1.0.md | logchange add 0.1.0
# or
logchange add 0.2.0 -i `cat NOTES_0.2.0.md`

# update existing or create a new section in latest release
logchange add latest added -i 'New feature'

# set unreleased section
logchange set unreleased fixed -i 'Unreleased fix'

# list released versions
logchange list
< 0.1.0
< 0.2.0

# check release notes sections
logchange get 0.1.0 added
< - New awesome feature
< - Another feature
```

### GitHub Actions

See [workflows](https://github.com/vemel/logchange/tree/main/examples/workflows) folder.

## Versioning

`logchange` version follows [PEP 440](https://www.python.org/dev/peps/pep-0440/).

## Latest changes

Full changelog can be found in [Releases](https://github.com/vemel/logchange/releases).

