# uv-pre-commit

**Repository Path**: moran3/uv-pre-commit

## Basic Information

- **Project Name**: uv-pre-commit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-18
- **Last Updated**: 2025-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# uv-pre-commit

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![image](https://img.shields.io/pypi/v/uv.svg)](https://pypi.python.org/pypi/uv)
[![image](https://img.shields.io/pypi/l/uv.svg)](https://pypi.python.org/pypi/uv)
[![image](https://img.shields.io/pypi/pyversions/uv.svg)](https://pypi.python.org/pypi/uv)
[![Actions status](https://github.com/astral-sh/uv-pre-commit/workflows/main/badge.svg)](https://github.com/astral-sh/uv-pre-commit/actions)
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/astral-sh)

A [pre-commit](https://pre-commit.com/) hook for [uv](https://github.com/astral-sh/uv).

Distributed as a standalone repository to enable installing uv via prebuilt wheels from
[PyPI](https://pypi.org/project/uv/).

### Using uv with pre-commit


To ensure the lockfile is up-to-date:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    # Update the uv lockfile
    - id: uv-lock
```

To autoexport `uv.lock` to `requirements.txt`:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    - id: uv-export
```

To export to an alternative file, modify the `args`:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    - id: uv-export
      args: ["--frozen", "--output-file=requirements-custom.txt"]
```

To compile your requirements via pre-commit, add the following to your `.pre-commit-config.yaml`:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    # Run the pip compile
    - id: pip-compile
      args: [requirements.in, -o, requirements.txt]
```

To compile alternative files, modify the `args` and `files`:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    # Run the pip compile
    - id: pip-compile
      args: [requirements-dev.in, -o, requirements-dev.txt]
      files: ^requirements-dev\.(in|txt)$
```

To run the hook over multiple files at the same time:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    # Run the pip compile
    - id: pip-compile
      name: pip-compile requirements.in
      args: [requirements.in, -o, requirements.txt]
    - id: pip-compile
      name: pip-compile requirements-dev.in
      args: [requirements-dev.in, -o, requirements-dev.txt]
      files: ^requirements-dev\.(in|txt)$
```

To run a hook on a project within a subdirectory (i.e., in a monorepo):

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    # Update the uv lockfile
    - id: uv-lock
      # Change <path/to/project> to your relative path
      files: <path/to/project>/pyproject.toml
      args: [--project, <path/to/project>]
```

To synchronize your dependencies upon branch checkout, pull or rebase:

```yaml
default_install_hook_types:
  - pre-commit
  - post-checkout
  - post-merge
  - post-rewrite
repos:
  - repo: https://github.com/astral-sh/uv-pre-commit
    # uv version.
    rev: 0.7.13
    hooks:
      - id: uv-sync
```

In order to install this hook, you either need to specify `default_install_hook_types` (as above) and run `pre-commit install`, 
or you have to install it via `pre-commit install --install-hooks -t post-checkout -t post-merge -t post-rewrite`.

To synchronize all dependencies in a workspace:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    - id: uv-sync
      args: ["--locked", "--all-packages"]
```

If you use [`keyring`](https://github.com/jaraco/keyring) to authenticate to a private index,
include it as an additional sync dependency:

```yaml
- repo: https://github.com/astral-sh/uv-pre-commit
  # uv version.
  rev: 0.7.13
  hooks:
    - id: uv-sync
      additional_dependencies: [keyring]
```

## License

uv-pre-commit is licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in uv-pre-commit by you, as defined in the Apache-2.0 license, shall be
dually licensed as above, without any additional terms or conditions.

<div align="center">
  <a target="_blank" href="https://astral.sh" style="background:none">
    <img src="https://raw.githubusercontent.com/astral-sh/ruff/main/assets/svg/Astral.svg">
  </a>
</div>