uv-dynamic-versioning

Warnings

• breaking Starting from v0.9.0, `uv-dynamic-versioning` no longer auto-coerces configuration values. Boolean and other types must be set explicitly with their correct type.
  Fix: Ensure all configuration values in `pyproject.toml` (e.g., `bump`, `tag`) are set with their correct Python type (e.g., `bump = true` instead of `bump = "true"`).
• gotcha The minimum Python version requirement was raised to 3.10.
  Fix: Ensure your development and build environments are running Python 3.10 or newer. Python 3.9 is no longer supported.
• gotcha When using `uv build`, remember that `uv` has its own build cache. If you change Git tags or commit messages that should alter the version, `uv` might serve a cached wheel with an old version string.
  Fix: To force a fresh build and ensure the latest dynamic version is applied, use `uv clean --all` or `uv build --refresh` before building your project. Refer to `uv`'s documentation on caching for more details.
• gotcha `uv-dynamic-versioning` primarily integrates with build systems (like `uv` or `hatch`) and modifies the project's version metadata during the build process. It's not a library intended for direct programmatic import and use within application code.
  Fix: Focus on configuring the tool via `pyproject.toml` and leveraging your chosen build orchestrator (`uv` or `hatch`) rather than attempting to import and call functions from `uv_dynamic_versioning` in your Python application.

Install

• pip install uv-dynamic-versioning Install with pip

Imports

• uv-dynamic-versioning

  This library is primarily configured via `pyproject.toml` and invoked indirectly through build tools like `uv` or `hatch`. Direct Python imports are not a typical use case for end-users.

  Users interact with this tool via `pyproject.toml` configuration and command-line execution (e.g., `uv build`), rather than importing Python modules.

Quickstart

Configure dynamic versioning in your `pyproject.toml` and then use `uv build` to build your project, allowing `uv-dynamic-versioning` to automatically determine and apply the version based on your VCS tags.

# pyproject.toml
[project]
name = "my-dynamic-project"
version = "0.0.0" # This placeholder will be overwritten by uv-dynamic-versioning

[tool.uv-dynamic-versioning]
# Optional: Specify version source and style
source = "git_archive"
style = "default"

# Terminal
pip install uv uv-dynamic-versioning
git init
git add .
git commit -m "Initial commit"
git tag 0.1.0
uv build