Skip to main content

KAC (Keep-a-Changelog)

A command line tool for bumping Changelogs that follow the Keep A Changelog standard.

Install

pip install kac

Run

Run kac in the same directory as your Changelog, or pass the filepath as an argument. By default, kac looks for a file called CHANGELOG.md (case-insensitive).

Example

Assuming you have a Changelog file at v3.6.2 name CHANGELOG.md in your current directory.

  1. Run kac
    $ kac
    
  2. Choose a bump version
    ? Please select a new version (currently v3.6.2)  (Use arrow keys)
       v3.6.3
     » v3.7.0
       v4.0.0
    
  3. Confirm version bump (Y / Enter)
    ? Bump Changelog to v3.7.0? (Y/n)
    
  4. Changelog bumped
    Changelog bumped to v3.7.0!
    

Limitations

  • Only works for semver
  • Only supports versions in the MAJOR.MINOR.PATCH format. A beta version ending in -beta, for example, will fail.
  • Requires Python 3.8.0

To-Do

  • Add support for generating an empty Changelog template
  • Undo bump
  • Support labels for pre-release and build metadata

Metadata

Release files for kac 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kac 0.1.2
File Size Uploaded
kac-0.1.2.tar.gz 4.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kac 0.1.2
File Interpreter ABI Platform
kac-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 9.9 kB

Release files / kac-0.1.2.tar.gz

Download URL kac-0.1.2.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2b0deb6ec22ea1aaf023f77864232895e7d677abf44975467f9ab89a6bc8f0e3
BLAKE2b-256 checksum
How to use checksums
3a69df9a6cad21248415b9f7354416f152738d2df679c004098d22013e5ee0aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.8.0

Release files / kac-0.1.2-py3-none-any.whl

Download URL kac-0.1.2-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
82902fda6f9e01ef79f3381dd15efb4ba9bbcbb13c67ec7af52607fff80bfc42
BLAKE2b-256 checksum
How to use checksums
7af6d297cf222fdc079fec3497604b3f58b5171748b58dfc68330511c7b18518
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.8.0

Release history Release notifications | RSS feed

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.3

3 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

3 release files

This release

0.1.2 This release

2 release files

0.1.1

3 release files

0.1.0

4 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page