Metadata-Version: 2.4
Name: cl-keeper
Version: 0.0.1
Summary: A CLI tool for keeping your changelogs tidy
Author-email: Tamika Nomara <taminomara@gmail.com>
License-Expression: MIT
Project-URL: Documentation, https://cl-keeper.readthedocs.io/en/stable/
Project-URL: Issues, https://github.com/taminomara/cl-keeper/issues/
Project-URL: Source, https://github.com/taminomara/cl-keeper/
Project-URL: Changelog, https://github.com/taminomara/cl-keeper/blob/main/CHANGELOG.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yuio<3,>=2.1.0
Requires-Dist: giturlparse==0.13.0
Requires-Dist: markdown-it-py==4.0.0
Requires-Dist: mdformat==1.0.0
Requires-Dist: mdformat-gfm==1.0.0
Requires-Dist: mdformat_footnote==0.1.2
Requires-Dist: mdformat_gfm_alerts==2.0.0
Requires-Dist: semver==3.0.4
Requires-Dist: packaging==25.0
Requires-Dist: PyYAML==6.0.3
Dynamic: license-file

# ChangeLog Keeper

A CLI tool that helps you with maintaining `CHANGELOG.md`
using [keep a changelog] format.

## Resources

- [Documentation](https://cl-keeper.readthedocs.io/)
- [Issues](https://github.com/taminomara/cl-keeper/issues)
- [Source](https://github.com/taminomara/cl-keeper/)
- [PyPi](https://pypi.org/project/cl-keeper/)
- [Changelog](https://github.com/taminomara/cl-keeper/blob/main/CHANGELOG.md)

## GitHub action quickstart

Use `taminomara/cl-keeper@v1` to parse a change log. It takes git tag
(parameter `version`) and returns `text` and other release info.
See details in [documentation][GitHub Action].

**Example:**

```yaml
name: Create a release
  on:
    push:
      tags:
        - 'v*'
jobs:
  release:
    - name: Checkout source
      uses: actions/checkout@v4
    - id: changelog
      name: Parse Changelog
      uses: taminomara/cl-keeper@v1
      with:
        version: ${{ github.ref }}
    - name: Create GitHub release
      uses: softprops/action-gh-release@v2
      with:
        prerelease: ${{ fromJSON(steps.changelog.outputs.is-pre-release) }}
        draft: ${{ fromJSON(steps.changelog.outputs.is-unreleased) }}
        body: |
          ## Changelog

          ${{ steps.changelog.outputs.text }}
```

## Installation

Install [via pipx][pipx-install]:

```sh
pipx install cl-keeper
```

[GitHub Action]: https://cl-keeper.readthedocs.io/en/stable/advanced.html#using-changelog-keeper-in-github-actions
[keep a changelog]: https://keepachangelog.com/
[pipx-install]: https://cl-keeper.readthedocs.io/en/stable/installation.html#with-pipx
