Changelogtxt-parser

Overview

Changelogtxt-parser is a lightweight Python utility designed to help you manage changelog files. It offers a command-line interface (CLI) that can:

• Check if a tag exists.
• Check the changelog format.
• Compare two changelog files.
• Add a new tag.
• Add a new unreleased entry.

Installation

You can use Changelogtxt-parser in two ways:

1. Install in your project:

uv add git+https://github.com/geopozo/changelogtxt-parser

After installation, verify that it’s working by running:

uv run changelogtxt --help

2. From source using uvx (recommended for latest version):

uvx --from git+https://github.com/geopozo/changelogtxt-parser changelogtxt --help

Using Changelogtxt-parser

usage: changelogtxt [-h] [--logistro-human]
[--logistro-structured] [--logistro-level LOG]
{check-tag,check-format,summarize-news,update} ...

changelogtxt helps you manage your changelog file.
changelogtxt COMMAND --help for information about commands.

positional arguments:
  {check-tag,check-format,summarize-news,update}
    check-tag           Checks if a tag in the changelog
                        matches the specified tag.
    check-format        Check changelog format.
    summarize-news      Compare source file with target file.
    update              Creates a new version entry if it
                        doesn't exist.

options:
  -h, --help            show this help message and exit
  --logistro-human      Format the logs for humans
  --logistro-structured
                        Format the logs as JSON
  --logistro-level LOG  Set the logging level (no default,
                        fallback to system default)

License

This project is licensed under the terms of the MIT license.