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

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.1
File Size Uploaded
kac-0.1.1.tar.gz 4.3 kB Details

Built distributions (wheels)

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

Total release size: 14.5 kB

Release files / kac-0.1.1.tar.gz

Download URL kac-0.1.1.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
39b4053827b68ed626775c977a5057be53bba590ad1c386d9105e8a7152464f9
BLAKE2b-256 checksum
How to use checksums
f0e83ea555300491e40b3949c8dd7c2434ffa234c5d2ae8772cccb136063a718
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.1-py3.8.egg

Download URL kac-0.1.1-py3.8.egg
Size 4.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
6835b52674ee2fbc9174448172c5222a1ec44c5088d18f16ac47d9927b998854
BLAKE2b-256 checksum
How to use checksums
44521153dd27ae258bab35da6467365d2c8abdfc6092ce7f36b5ad267b62dbb5
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.1-py3-none-any.whl

Download URL kac-0.1.1-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ba4a6ef2e39eabe138cb778ef9acc63aa917e4e1e442c920af03f0ea1d3e3261
BLAKE2b-256 checksum
How to use checksums
645f8c4bb989b83859d31c493699197fdca655263e8b874c849d208b30633eeb
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

This release

0.1.1 This release

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