Skip to main content

Table of Contents
  1. About
  2. Quick Start
  3. Usage
  4. Development
  5. Contributing
  6. License

About

usechange is a Python CLI for generating changelogs and release notes from Conventional Commits. It reads git history between refs, groups commits by type, renders Markdown release notes, and can update version numbers based on semantic versioning rules.

It gives you:

  • Changelog generation - Render release notes and optionally write to CHANGELOG.md.
  • Semver bumping - Determine version bumps from commit types and breaking changes.
  • Release workflows - Tag and publish using uv and gh.
  • GitHub sync - Sync release notes to GitHub releases.
  • Repo metadata - Create commit and compare links automatically.

(back to top)

Quick Start

usechange provides a short alias and command shortcuts:

  • usechange and change are equivalent.
  • changelog also supports the log alias.
uv add usechange

Install with pip (alternative)

pip install usechange

Generate a changelog

change log --write

Interactive release workflow

change release

Sync the latest release to GitHub

change github release

Interactive changelog preview

Example prompt for selecting optional changelog flags:

Select optional flags (space to select, enter to confirm):
> [ ] --from - Start commit reference
  [ ] --to - End commit reference
  [ ] --dir - Path to a git repository
  [ ] --clean [bool] - Ensure working directory is clean
  [ ] --output - Changelog file to write
  [ ] --write [bool] - Write changelog to CHANGELOG.md
  [ ] --no-output [bool] - Do not write a changelog file
  [ ] --noAuthors [bool] - Skip contributors section
  [ ] --noDate [bool] - Omit date from header
  [ ] --noEmojis [bool] - Omit emojis from headers
  [ ] --hideAuthorEmail [bool] - Hide author email if no username is found
  [ ] --bump [bool] - Determine and update version
  [ ] -r - Release as a specific version
  [ ] --release [bool] - Bump, tag, and release
  [ ] --no-commit [bool] - Skip release commit
  [ ] --no-tag [bool] - Skip release tag
  [ ] --push [bool] - Push commits and tags
  [ ] --no-github [bool] - Skip GitHub release sync
  [ ] --publish [bool] - Publish after generating
  [ ] --publishTag - Publish with a custom tag
  [ ] --nameSuffix - Append suffix to package name
  [ ] --versionSuffix - Append suffix to version
  [ ] --canary - Shortcut for --bump and --versionSuffix
  [ ] --major [bool] - Force major bump
  [ ] --minor [bool] - Force minor bump
  [ ] --patch [bool] - Force patch bump
  [ ] --premajor - Force premajor bump
  [ ] --preminor - Force preminor bump
  [ ] --prepatch - Force prepatch bump
  [ ] --prerelease - Force prerelease bump
Press <space>, <tab> for multi-selection and <enter> to accept

(back to top)

Usage

Generate changelog

change log --from v0.1.0 --to HEAD --output CHANGELOG.md

Version bumping

change log --bump --write
change log --major --write

Release workflow

change release --yes

GitHub release sync

change github release 0.2.0
change gh release all

Configuration

usechange reads configuration from one of the following:

  • changelog.config.json
  • .changelogrc
  • changelog.config.toml
  • pyproject.toml under [tool.changelog]

(back to top)

Development

Common tasks:

uv run poe test
uv run poe lint
uv run poe format
uv run poe typecheck
uv run poe clean-full

(back to top)

Contributing

Quick workflow:

  1. Fork and branch: git checkout -b feature/name
  2. Make changes
  3. Run checks: uv run poe clean-full
  4. Commit and push
  5. Open a Pull Request

(back to top)

License

License not yet specified in this repository.

(back to top)


Built by thememium

Metadata

Release files for usechange 0.1.49

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

Source distribution (sdist)

Source distribution for usechange 0.1.49
File Size Uploaded Provenance Actions
usechange-0.1.49.tar.gz 20.1 kB Without provenance Details for usechange-0.1.49.tar.gz

Built distribution (wheel)

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

Total release size: 46.7 kB

Release files / usechange-0.1.49.tar.gz

Download URL usechange-0.1.49.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4f84aaecb72f7723918270700844aa4afdf896a663c4bed5552681743a1999f2
BLAKE2b-256 checksum
How to use checksums
d14167a789b04338a7aabfd6982cd42c5c647a27df8621e0fd33c4c00c1d50b6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / usechange-0.1.49-py3-none-any.whl

Download URL usechange-0.1.49-py3-none-any.whl
Size 26.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b3acfe9f6e2dde9911c4ce2c511269bfe16134cb6a85c73f1f3005817a2b2186
BLAKE2b-256 checksum
How to use checksums
d98b30f73a2dbc7edfccc42b82a5ccd264de191830ed7ac639a6bb7bed4fdcd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for usechange 0.1.49

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.49 This release

2 release files No provenance

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