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.0

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.0
File Size Uploaded
kac-0.1.0.tar.gz 4.2 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for kac 0.1.0
File Interpreter ABI Platform
kac-0.1.0-py3.8.egg Legacy Egg format - - Details
kac-0.1.0-py3-none-any.whl Python 3 none any Details
kac-0.1-py3.8.egg Legacy Egg format - - Details

Total release size: 22.5 kB

Release files / kac-0.1.0.tar.gz

Download URL kac-0.1.0.tar.gz
Size 4.2 kB
Tags Source
SHA-256 checksum
How to use checksums
73232ffee5e2bc8079f109787f9f22171b6789b5ce903b35c9ebfce1f44a303d
BLAKE2b-256 checksum
How to use checksums
4cb5f069658eb68dce9b652dde4f7ef25e68be5ed07b09d01771a7d2dba79125
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.0-py3.8.egg

Download URL kac-0.1.0-py3.8.egg
Size 9.0 kB
Tags Egg
SHA-256 checksum
How to use checksums
d0387071198913f24039459803df2a6e48920f1e5994dacdb1dd0885fdbfc9cb
BLAKE2b-256 checksum
How to use checksums
58733dd986aa6887f756331da2bc0a8b1fb9e9d7d8438ef4f92e6d38be7b542c
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.0-py3-none-any.whl

Download URL kac-0.1.0-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
01d21d3030978e762462325542e4919ddfccda008e0e088465d004135d263767
BLAKE2b-256 checksum
How to use checksums
94d45a93a9c33528278e123d2eb13cb7d99f72c23e2c0069e460a152ba218915
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-py3.8.egg

Download URL kac-0.1-py3.8.egg
Size 3.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
8875cf5a0357f3e057d0bad6f74206746e7c6584f8f2f857271778acccf12ed6
BLAKE2b-256 checksum
How to use checksums
c3b812def7d079430a30767cce7fbda039262a52295fb95f4d9c2fd4f65fd6b3
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

0.1.2

2 release files

0.1.1

3 release files

This release

0.1.0 This release

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