README.md

Obsessive-Compulsive Development Changelogs

ocdc is a changelog formatter for "people", neat freaks, and sloppy typists.

The format is based on Keep a Changelog, with some slight modifications:

• Lines are wrapped at 90 characters.
• Version sections are separated by two blank lines to aid visual scanning.
• Square brackets are not used in titles.

Installation

$ pip install ocdc

Usage

To format CHANGELOG.md in the current directory, run ocdc without arguments. You can also pass a custom path.

$ ocdc [--path CHANGELOG.md]

To check CHANGELOG.md without modifying the file, use --check.

$ ocdc --check [--path CHANGELOG.md]

To create a new CHANGELOG.md, use the new subcommand.

$ ocdc new [--force]

For a description of all options, use --help.

$ ocdc --help

Configuration

Configuration is for the weak-willed. There shall be only one true format.