Skip to main content

Yaclog: Yet Another Commandline Changelog Tool

Documentation Status CI Status PyPI version

Yaclog is a python library and command line tool to make it easier to keep track of changes to your projects. It includes commands for appending new changes to a markdown changelog file, as well as releasing new versions for deployment via git tags.

a yak who is a log

Logo by Erin Cassidy

Installation

Install and update with pip:

$ pip install -U yaclog

Or with uv:

$ uv tool install yaclog

Usage

For usage from the command line, yaclog provides the yaclog command:

Usage: yaclog [OPTIONS] COMMAND [ARGS]...

  Manipulate markdown changelog files.

Options:
  --path FILE  Location of the changelog file.  [default: CHANGELOG.md]
  --version    Show the version and exit.
  --help       Show this message and exit.

Commands:
  entry    Add entries to the changelog.
  format   Reformat the changelog file.
  init     Create a new changelog file.
  release  Release versions.
  show     Show changes from the changelog file
  tag      Modify version tags

Example workflow

Create a new changelog:

$ yaclog init

Add some new entries to the current unreleased version:

$ yaclog entry -b 'Introduced some more bugs'
$ yaclog entry -b 'Introduced some more features'

Show the current version:

$ yaclog show
Unreleased

- Introduced some more bugs
- Introduced some more features

Release the current version and make a git tag for it

$ yaclog release 0.0.1 -c
Renamed version "Unreleased" to "0.0.1".
Commit and create tag for version 0.0.1? [y/N]: y
Created commit a7b6789
Created tag "0.0.1".

Metadata

Release files for yaclog 1.7.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 yaclog 1.7.2
File Size Uploaded
yaclog-1.7.2.tar.gz 88.8 kB Details

Built distribution (wheel)

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

Total release size: 110.2 kB

Release files / yaclog-1.7.2.tar.gz

Download URL yaclog-1.7.2.tar.gz
Size 88.8 kB
Tags Source
SHA-256 checksum
How to use checksums
032371d0f6797ae256e48137bac2bb7c977fe3be3fa41fb597e727c1de7627b1
BLAKE2b-256 checksum
How to use checksums
3218f527fe5271c451f8457459cb16eed73bc0dcab442c6f07aaa303b5360b1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / yaclog-1.7.2-py3-none-any.whl

Download URL yaclog-1.7.2-py3-none-any.whl
Size 21.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3fcbb7a0a8b82bac9b4e10e8ea3982a762680da496e41bcfa82e792393af5a35
BLAKE2b-256 checksum
How to use checksums
d3497208e596661c4c058ea7187cb4519b6d4484e962dd8db106b84b18d0ceff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

1.7.2 This release

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 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