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.5.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

ocdc-0.5.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file ocdc-0.5.0.tar.gz.

File metadata

  • Download URL: ocdc-0.5.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for ocdc-0.5.0.tar.gz
Algorithm Hash digest
SHA256 901a78d5941140b80012d3045c5e94bfdb41550a799d877f4231d91ec89e57a4
MD5 8ebcb73278d8888528ebd8ee23d505df
BLAKE2b-256 0bd29adea1bcab3674b7872398030d05d2b8f115016988d7d9cbf7f416a7b6b8

See more details on using hashes here.

File details

Details for the file ocdc-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: ocdc-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for ocdc-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05d7bccaadce766504c177290b8186a4757ecb2b70d2c4a0547c6b79810f89ca
MD5 29c3acb7be443d9a3ce05d64c0f201a6
BLAKE2b-256 dba191c44bb411aa968158033340a6f774ceee8806860b33d934c773bd6b974e

See more details on using hashes here.

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