Skip to main content

Define your package's version from vcs refs, with build-time tuning of which tags to use.

Project description

hatch-vcs-tunable

PyPI - Version PyPI - Python Version Ruff Checked with mypy


This is a plugin for Hatch that extends the plugin hatch-vcs to allow for overriding some config elements with environment variables.

The reason you might want to do this is if you have multiple release tracks for your package, or multiple contexts in which it is used, and want to give it different versions in those different contexts.

Table of Contents

Plugin

Ensure hatch-vcs-tunable is listed in the build-system.requires field in your pyproject.toml:

[build-system]
requires = ["hatchling", "hatch-vcs-tunable"]
build-backend = "hatchling.build"

Configuration

hatch-vcs-tunable can be configured either through pyproject.toml, using exactly the same configuration elements as hatch-vcs but with the plugin name vcs-tunable, or via environment variable overrides.

pyproject.toml

Use the same configuration elements as hatch-vcs, but the plugin name vcs-tunable. For instance, to set the version file you would do:

[tool.hatch.build.hooks.vcs-tunable]
version-file="_version.py"

Environment

The environment variables should be specified as ALL_CAPS_UNDERSCORE versions of the pyproject settings, prefixed with HATCH_VCS_TUNABLE_. So for instance,

  • tag-pattern can be specified as HATCH_VCS_TUNABLE_TAG_PATTERN
  • fallback-version can be specified as HATCH_VCS_TUNABLE_FALLBACK_VERSION

raw-options

The value of the raw-options is passed directly to setuptools_scm. It may have multiple keyword arguments, which need both a name and a value, and the keywords may not be safe to put in the names of environment variables, so both the names and values are passed in the environment variable value. These should be passed as a string of key-name=value separated by ;. For instance, to specify both relative_to=.. and version_file=/some/path, you would do HATCH_VCS_TUNABLE_RAW_OPTIONS="relative_to=..;version_file=/some/path".

If a setting is specified both in the environment and in pyproject.toml, the environment variable will take priority.

Environment variables that are specified as empty still exist, so if you do HATCH_VCS_TUNABLE_FALLBACK_VERSION= hatch build, the fallback version will be the empty string. If you have one of these environment variables defined all the time and need to remove it, use unset.

License

hatch-git-version-tunable is distributed under the terms of the Apache-2.0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hatch_vcs_tunable-0.0.0.dev0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

hatch_vcs_tunable-0.0.0.dev0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file hatch_vcs_tunable-0.0.0.dev0.tar.gz.

File metadata

File hashes

Hashes for hatch_vcs_tunable-0.0.0.dev0.tar.gz
Algorithm Hash digest
SHA256 736ea8afe06e4ad3ac461419c5d82587f72cb48515c69a7f76aa9c03630b9ca4
MD5 d82cdabfe7b7a0f394fdbb1f9d6b1430
BLAKE2b-256 2b1a01802069d7a5afc1480a6b5536721bb1d92c723e1673e2d7de03261f098e

See more details on using hashes here.

Provenance

File details

Details for the file hatch_vcs_tunable-0.0.0.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for hatch_vcs_tunable-0.0.0.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 adc64850d8131edf6ac279cd2e4a0baa075b95ce1760e0da23469bec02c2f79d
MD5 13960b8ca1e92454ffc070a681a80b51
BLAKE2b-256 01ff2b3be72bebd47366694c5cb10fd8734f762bfb962fb7ef01208deaab2a29

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page