hatch-env-plus 1.0.0

A version source for Hatchling that reads the version from a given environment variable, but also allows for a fallback if the variable is not populated.

Hatchling Environment Variable Version Source

A Hatchling version source plugin that reads the version from an environment variable with a configurable fallback value, since the built-in env version source does not allow to define a fallback.

Installation

Add the package as a build dependency to your pyproject.toml:

[build-system]
requires = ["hatchling", "hatch-env-plus"]
build-backend = "hatchling.build"

Configuration

Configure a dynamic version source in the project section of pyproject.toml:

[project]
dynamic = ["version"]

Make sure you don't specify the version directly in the project section, or the dynamic version source may not be picked up.

Then, configure the version source:

[tool.hatch.version]
source = "env-plus"
variable = "PACKAGE_VERSION"  # optional, default shown
fallback = "0.0.0dev0"  # optional, default shown

Use the variable field to set the environment variable to use, and set fallback to the desired fallback version.

Note: An empty string, whether from the configured environment variable or from the fallback, is an undefined version.

If you explicitly set the configured environment variable to the empty string, your build will fail as no valid version is set. If you explicitly set fallback to an empty string, your build will fail when the configured environment variable is not set. This is the default behavior of Hatchling's built-in enviroment variable version source env.

Usage

Build your project with the desired version by setting the environment variable:

PACKAGE_VERSION=2.0.0 uv build
# Builds package version "2.0.0".

Leave the environment variable empty to use the default:

uv build
# Builds package version 0.0.0dev0 (or configured fallback).