Skip to main content

alver

Easy management of versions, releases and changelog.

The alver release flow

  • Run alver bump vx.y.z
  • Edit CHANGELOG.md as needed.
  • Create a PR, discuss, merge.
  • -> Github does the rest (publish release to Pypi and GH).

This flow is based on the idea that a release deserves the care of a human to at least approve the generated release notes, but from then on a release should be as automatic as it can get.

The release workflow on Github Actions triggers when a branch named release is merged into main, but can also be triggered manually or by pushing a tag vx.y.z. So if you e.g. forgot to setup the trusted publisher, you can just retry.

Adopting the alver flow in your project

Install alver:

  • pip install alver or use your favorite installer.

Meet the assumptions made by alver:

  • Your version is defined in pyproject.toml, __init__.py, or _version.py.
  • You have a CHANGELOG.md with headers marked as ## [v1.0.0] - 09-11-2026. If no changelog exists, alver will create it.

To setup Github actions:

  • Copy release.yml into your project.
  • Create a build.yml that does the build and published the artifacts to dist.
  • At Pypi: setup trusted publishing, using release.yml and the pypi environment.
  • At Github: in the settings create an environment called pypi.

Using the alver CLI tool

usage: alver [-h] {version,gitversion,format,bump,notes,changelog-from-gh,changelog-to-gh} ...

positional arguments:
  {version,bump,notes,changelog-from-gh,changelog-to-gh}
    version             Print the current project version (from _version.py, __init__.py, or pyproject.toml).
    gitversion          Print the detailed project version based on git tags and history (like 'version', but refined), e.g. 1.2.3.post4+gabcdef1.
    format              Format CHANGELOG.md in place, fixes section headers and blank lines.
    bump                Bump to the given version and add a changelog section with gh-generated release notes, e.g. `alver bump v1.2.3`.
    notes               Print the release notes for the given version from CHANGELOG.md, e.g. `alver notes v1.2.3`.
    changelog-from-gh   Create/update CHANGELOG.md sections from the GitHub releases of this repo for the given version, e.g. `alver
                        changelog-from-gh v1.2.3` ('*' = all releases).
    changelog-to-gh     Update the gh release notes from the CHANGELOG.md section of the given version, e.g. `alver changelog-to-gh v1.2.3`
                        ('*' = all sections).

options:
  -h, --help            show this help message and exit

Using alver as a library

  • get_detailed_version_of_lib(module) -> str | None: get the git-enhanced version of a library.
  • get_detailed_version(version: str, filename: str) -> str: get the git-enhanced version of a module's version and filename.

Metadata

Release files for alver 1.2.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 alver 1.2.0
File Size Uploaded Provenance Actions
alver-1.2.0.tar.gz 14.5 kB With provenance Details for alver-1.2.0.tar.gz

Built distribution (wheel)

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

Total release size: 30.8 kB

Release files / alver-1.2.0.tar.gz

Download URL alver-1.2.0.tar.gz
Size 14.5 kB
Tags Source
SHA-256 checksum
How to use checksums
dbbfb43ab27bc90f66d74ea47f94752089bb041de8babe6513e969fb62c480d1
BLAKE2b-256 checksum
How to use checksums
338b45b9f4eb80aa5f26693ff475d0102008affc1277cc587c411712d649474f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Release files / alver-1.2.0-py3-none-any.whl

Download URL alver-1.2.0-py3-none-any.whl
Size 16.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f8fdb2f8bba47f5be3dcd31387fc9c2f1f39881610bcfa4d6b3bc221ea7b9dda
BLAKE2b-256 checksum
How to use checksums
e888a53282483ae3f4da8fdfc1e43723aa0735c0b1403fc04b84e12043cc7fed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Security for alver 1.2.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for alver-1.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

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.

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