Skip to main content

A dynamic version source plugin for uv workspaces.

Project description

uv-workspace-dynamic-versioning

PyPI version CI Status Coverage SLSA Level 3 License

A powerful Hatch plugin for dynamic versioning and dependency injection in uv workspaces.


📖 Context & Origin

This project was created to address a specific limitation in the existing uv-dynamic-versioning plugin when used within complex monorepos and uv workspaces.

As discussed in ninoseki/uv-dynamic-versioning#81, the standard implementation often calculates version distance and commit hashes based on the entire repository history. In a workspace with multiple packages, this leads to:

  1. False Positives: Packages bumping versions when unrelated code in the workspace changes.
  2. Inaccurate Metadata: Commit hashes reflecting global repo state rather than the state of the specific package.

uv-workspace-dynamic-versioning introduces Directory-Specific Patching. It re-calculates the Git distance and commit hash by filtering the history to the specific package subdirectory, ensuring that versions only reflect changes relevant to that package.


🚀 Key Features

  • VCS-Powered Versioning: Automatically derive versions from Git, Mercurial, and more via Dunamai.
  • Workspace Aware: Accurate distance and commit hash calculation restricted to the project subdirectory.
  • Dynamic Dependencies: Inject versions into dependencies using Jinja2 templates (e.g., pkg == {{ version.base }}).
  • Secure by Design: Sandboxed Jinja2 environment and Path Traversal protection.
  • Highly Configurable: Custom formats, bumping logic, and fallback versions.

🛠 Quick Start

1. Installation

Add the plugin to your build-system.requires in pyproject.toml:

[build-system]
requires = ["hatchling", "uv-workspace-dynamic-versioning"]
build-backend = "hatchling.build"

2. Basic Configuration

Enable the version source and mark the version as dynamic:

[project]
name = "my-awesome-package"
dynamic = ["version"]

[tool.hatch.version]
source = "uv-workspace-dynamic-versioning"

📚 Documentation

For full guides and API reference, visit our Documentation Site.


⚖️ License

Distributed under the terms of the MIT 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

uv_workspace_dynamic_versioning-0.1.4.tar.gz (120.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file uv_workspace_dynamic_versioning-0.1.4.tar.gz.

File metadata

File hashes

Hashes for uv_workspace_dynamic_versioning-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9527f43eceefb4266605f1f6a5f710e945c4f70b88fe79bd697ba0088aeb40c7
MD5 2239f6c3fd6518327d04e6d467118bd9
BLAKE2b-256 5e31d55bd1e8569e73bd4b590e5b7b906b96a36e1fd175c78e9a36aa4a278797

See more details on using hashes here.

Provenance

The following attestation bundles were made for uv_workspace_dynamic_versioning-0.1.4.tar.gz:

Publisher: ci.yml on indiVar0508/uv-workspace-dynamic-versioning

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file uv_workspace_dynamic_versioning-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for uv_workspace_dynamic_versioning-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 89aa98027951791d8a8c2547837384b06bacf06950fc525be7d9cb5a08ba84c2
MD5 39e833e07c3a6318619b420a5b1ff625
BLAKE2b-256 9bd8595b8bad9d2b37eaf9495b66c62f55344abce55fbeaa453867411cac8e3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for uv_workspace_dynamic_versioning-0.1.4-py3-none-any.whl:

Publisher: ci.yml on indiVar0508/uv-workspace-dynamic-versioning

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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