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.5.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

pre_commit_uv-4.1.5-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pre_commit_uv-4.1.5.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pre_commit_uv-4.1.5.tar.gz
Algorithm Hash digest
SHA256 3f40714152b4f4aa484703b8dbfeb9baa0aaedb17207e0012b3561da756d577d
MD5 ebdb15acbc2d4e169638b508a885ea26
BLAKE2b-256 3d0ce6ab71e93d8e78ffa36a1f8b6ce12014679e2b83b401404c12bb2840078f

See more details on using hashes here.

Provenance

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

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

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

File details

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

File metadata

  • Download URL: pre_commit_uv-4.1.5-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pre_commit_uv-4.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f4805e45615b898c4ca6ea37bdb60a05bb7830f986c303a06a378d6b50c3aa9e
MD5 ba87b1ec58bf8e06394edfee90e6c2cf
BLAKE2b-256 f7c6747bc58da9f0665c607890c73b349b3934381e312272f584808182655898

See more details on using hashes here.

Provenance

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

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

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page