<h2 align="center">Obsessive-Compulsive Development Changelogs</h2>
`ocdc` is a changelog formatter for "people", neat freaks, and sloppy typists.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
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
```console
$ pip install ocdc
```
## Usage
To format `CHANGELOG.md` in the current directory, run `ocdc` without arguments.
You can also pass a custom path.
```console
$ ocdc [--path CHANGELOG.md]
```
To check `CHANGELOG.md` without modifying the file, use `--check`.
```console
$ ocdc --check [--path CHANGELOG.md]
```
To create a new `CHANGELOG.md`, use the `new` subcommand.
```console
$ ocdc new [--force]
```
For a description of all options, use `--help`.
```console
$ 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`.
Raw data
{
"_id": null,
"home_page": "https://github.com/mdwint/ocdc",
"name": "ocdc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "changelog,markdown,formatter",
"author": "Matteo De Wint",
"author_email": "matteo@mailfence.com",
"download_url": "https://files.pythonhosted.org/packages/0b/d2/9adea1bcab3674b7872398030d05d2b8f115016988d7d9cbf7f416a7b6b8/ocdc-0.5.0.tar.gz",
"platform": null,
"description": "\n\n<h2 align=\"center\">Obsessive-Compulsive Development Changelogs</h2>\n\n`ocdc` is a changelog formatter for \"people\", neat freaks, and sloppy typists.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nwith some slight modifications:\n\n- Lines are wrapped at 90 characters.\n- Version sections are separated by two blank lines to aid visual scanning.\n- Square brackets are not used in titles. Changelogs aren't programming\n languages, so why throw in weird symbols like that?\n\n\n## Installation\n\n```console\n$ pip install ocdc\n```\n\n\n## Usage\n\nTo format `CHANGELOG.md` in the current directory, run `ocdc` without arguments.\nYou can also pass a custom path.\n\n```console\n$ ocdc [--path CHANGELOG.md]\n```\n\nTo check `CHANGELOG.md` without modifying the file, use `--check`.\n\n```console\n$ ocdc --check [--path CHANGELOG.md]\n```\n\nTo create a new `CHANGELOG.md`, use the `new` subcommand.\n\n```console\n$ ocdc new [--force]\n```\n\nFor a description of all options, use `--help`.\n\n```console\n$ ocdc --help\n```\n\n\n## Configuration\n\nConfiguration is for the weak-willed. There shall be only one true format.\n\n\n## Disclaimer\n\nThis thing is new, and it might eat your changelog! Back up your files (in git)\nbefore trying `ocdc`.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A changelog formatter for \"people\", neat freaks, and sloppy typists.",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/mdwint/ocdc",
"Repository": "https://github.com/mdwint/ocdc"
},
"split_keywords": [
"changelog",
"markdown",
"formatter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dba191c44bb411aa968158033340a6f774ceee8806860b33d934c773bd6b974e",
"md5": "29c3acb7be443d9a3ce05d64c0f201a6",
"sha256": "05d7bccaadce766504c177290b8186a4757ecb2b70d2c4a0547c6b79810f89ca"
},
"downloads": -1,
"filename": "ocdc-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29c3acb7be443d9a3ce05d64c0f201a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8538,
"upload_time": "2023-11-25T11:50:40",
"upload_time_iso_8601": "2023-11-25T11:50:40.604069Z",
"url": "https://files.pythonhosted.org/packages/db/a1/91c44bb411aa968158033340a6f774ceee8806860b33d934c773bd6b974e/ocdc-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0bd29adea1bcab3674b7872398030d05d2b8f115016988d7d9cbf7f416a7b6b8",
"md5": "8ebcb73278d8888528ebd8ee23d505df",
"sha256": "901a78d5941140b80012d3045c5e94bfdb41550a799d877f4231d91ec89e57a4"
},
"downloads": -1,
"filename": "ocdc-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "8ebcb73278d8888528ebd8ee23d505df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7075,
"upload_time": "2023-11-25T11:50:42",
"upload_time_iso_8601": "2023-11-25T11:50:42.727575Z",
"url": "https://files.pythonhosted.org/packages/0b/d2/9adea1bcab3674b7872398030d05d2b8f115016988d7d9cbf7f416a7b6b8/ocdc-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 11:50:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mdwint",
"github_project": "ocdc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ocdc"
}
JSON
