chachacha 0.1.2

Chachacha changes changelogs.

CHACHACHA

Chachacha changes changelogs.

Installation

Grab latest copy from releases page and place it where you can invoke it.

Alternatively you can choose to install Python package and cope with $PATH configuration.

$ pip install chachacha

...

Quickstart

Init a new changelog and then add some changes:

chachacha init
chachacha added Glad to meet you
cat CHANGELOG.md

Subcommands are modeled from Keep a Changelog specification:

chachacha --help
Usage: chachacha [OPTIONS] COMMAND [ARGS]...

Options:
  --filename TEXT  changelog filename
  --driver TEXT    changelog format driver
  --help           Show this message and exit.

Commands:
  init        initialize a new file
  release     release a version
  added       add an "added" entry
  changed     add a "changed" entry
  deprecated  add a "deprecated" entry
  fixed       add a "fixed" entry
  removed     add a "removed" entry
  security    add a "security" entry

Please note that KeepAChangelog format is a plugin, and implementing other formats is planned. KAC format driver heavily depends on Colin Bounouar's keepachangelog library.

Releasing a version is simple as:

chachacha release --help

Usage: chachacha release [OPTIONS]

  release a version

Options:
  --major  bump a major version
  --minor  bump a minor version
  --patch  bump a patch version
  --help   Show this message and exit.

Where:

• major: release a major
• minor: release a minor
• patch: release a patch

Specification on this behavious is directly taken from Semantic Versioning thanks to python semver library.