Changelog Keeper
Command line utility for keeping your changelog tidy
About the project
This tool aims to:
- make your changelog file standardized; and
- reduce the time spent on updating the changelog file by providing a suite of basic commands.
The Changelog standard is based on the keep-a-changelog convention with few adjustments, described in this document.
It is also possible (with some additional scripting/tooling) to incorporate this utility into your Continuous Integration & Continuous Delivery routines. There are few things to consider, mentioned in this document.
Getting started
Prerequisites
- Python >= 3.7
- Pip
Installation
# general installation
pip install changelog-keeper
# with specific version
pip install changelog-keeper==1.0.0
Usage
Changelog Keeper provides five simple commands allowing basic operations on the changelog file:
# Create new, empty changelog file
clkpr create [-f PATH]
# Add new entry to the changelog file
clkpr add [-f PATH] CHANGE_TYPE ENTRY
# Validate and (if needed and possible) fix the changelog file
clkpr check [-f PATH]
# Release a version (with optional link)
clkpr release [-f PATH] [-r URL] VERSION_NAME
# Yank released version
clkpr yank [-f PATH] VERSION_NAME
# For more details, one can check the help messages for the tool: `clkpr -h`
# and for a particular command: `clkpr <command> -h`
Contributing
Please have a look into CONTRIBUTING file for detailed suggestions regarding project contribution.
License
Distributed under the MIT License. See LICENSE file for more information.
1 maintainer
Metadata
1 maintainer
Release files for changelog-keeper 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| changelog-keeper-1.0.0.tar.gz | 13.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| changelog_keeper-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.2 kB
Release files / changelog-keeper-1.0.0.tar.gz
| Download URL | changelog-keeper-1.0.0.tar.gz |
|---|---|
| Size | 13.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d8f0d222de1a31dd9a8dbd91bcbf48059927a6c1f74e6af690b918068199ab4a
|
|
BLAKE2b-256 checksum How to use checksums |
8a1e2b4b0c41385fdfe09678ec789da0c67b15a1451fd4e19815862bfd3509f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Release files / changelog_keeper-1.0.0-py3-none-any.whl
| Download URL | changelog_keeper-1.0.0-py3-none-any.whl |
|---|---|
| Size | 14.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0ec8b4614be97c4cb566f7324a7b040dc6e227e3bcb829efcb2b24234abd093e
|
|
BLAKE2b-256 checksum How to use checksums |
77fa50d73f08934f51d161f49176c4c1aa1c5ac0f635096eacb0260054323b61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
