Skip to main content

A changelog formatter for "people", neat freaks, and sloppy typists.

Project description

OCDC Logo

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. Changelogs aren't programming languages, so why throw in weird symbols like that?

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.

Disclaimer

This thing is new, and it might eat your changelog! Back up your files (in git) before trying ocdc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ocdc-0.2.1.tar.gz (6.7 kB view hashes)

Uploaded source

Built Distribution

ocdc-0.2.1-py3-none-any.whl (7.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page