Skip to main content

Run pre-commit with uv

Project description

pre-commit-uv

PyPI PyPI - Implementation PyPI - Python Version Downloads PyPI - License check

Use uv to create virtual environments and install packages for pre-commit.

Installation

With pipx:

pipx install pre-commit
pipx inject pre-commit pre-commit-uv

With uv:

uv tool install pre-commit --with pre-commit-uv --force-reinstall

Why?

Compared to upstream pre-commit will speed up the initial seed operation. In general, upstream recommends caching the pre-commit cache, however, that is not always possible and is still helpful to have a more performant initial cache creation., Here's an example of what you could expect demonstrated on this project's own pre-commit setup (with a hot uv cache):

 hyperfine  'pre-commit install-hooks' 'pre-commit-uv install-hooks'
Benchmark 1: pre-commit install-hooks
  Time (mean ± σ):     54.132 s ±  8.827 s    [User: 15.424 s, System: 9.359 s]
  Range (min  max):   45.972 s  66.506 s    10 runs

Benchmark 2: pre-commit-uv install-hooks
  Time (mean ± σ):     41.695 s ±  7.395 s    [User: 7.614 s, System: 6.133 s]
  Range (min  max):   32.198 s  58.467 s    10 runs

Summary
  pre-commit-uv install-hooks ran 1.30 ± 0.31 times faster than pre-commit install-hooks

Configuration

Once installed will use uv out of box, however the DISABLE_PRE_COMMIT_UV_PATCH environment variable if is set it will work as an escape hatch to disable the new behavior.

To avoid interpreter startup overhead of the patching, we only perform this when we detect you calling pre-commit. Should this logic fail you can force the patching by setting the FORCE_PRE_COMMIT_UV_PATCH variable. Should you experience this please raise an issue with the content of the sys.argv. Note that DISABLE_PRE_COMMIT_UV_PATCH will overwrite this flag should both be set.

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

pre_commit_uv-4.1.4.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

pre_commit_uv-4.1.4-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file pre_commit_uv-4.1.4.tar.gz.

File metadata

  • Download URL: pre_commit_uv-4.1.4.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pre_commit_uv-4.1.4.tar.gz
Algorithm Hash digest
SHA256 3db606a79b226127b27dbbd8381b78c0e30de3ac775a8492c576a68e9250535c
MD5 88048fda370124368caeaf4685695ee9
BLAKE2b-256 b16cc3c1d01698c8abb0b546defc0304971fa7fb2ba84ad35587b9dad095d73f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pre_commit_uv-4.1.4.tar.gz:

Publisher: release.yaml on tox-dev/pre-commit-uv

Attestations:

File details

Details for the file pre_commit_uv-4.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pre_commit_uv-4.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7f01fb494fa1caa5097d20a38f71df7cea0209197b2564699cef9b3f3aa9d135
MD5 9eaa6200db915f5ffa0a7e05ff2d2af3
BLAKE2b-256 f1701b65f9118ef64f6ffe5d57a67170bbff25d4f4a3d1cb78e8ed3392e16114

See more details on using hashes here.

Provenance

The following attestation bundles were made for pre_commit_uv-4.1.4-py3-none-any.whl:

Publisher: release.yaml on tox-dev/pre-commit-uv

Attestations:

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