Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,11 @@ repos:
rev: v2.4.1
hooks:
- id: codespell
- repo: local
hooks:
- id: uv-lock-check
name: uv lock file check
entry: make uv-lock-check
language: system
pass_filenames: false
files: ^(pyproject\.toml|uv\.lock)$
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -168,3 +168,11 @@ clean: ## Remove build artifacts and caches
@find . -name "*.pyd" -exec echo Deleting {} \; -delete
@find . -name "*.pyo" -exec echo Deleting {} \; -delete
@echo "Cleanup complete."

uv-lock: ## Regenerate uv.lock file from pyproject.toml
uv lock $(PYTHON_ARG)

uv-lock-check: ## Verify uv.lock is up to date
@command -v uv >/dev/null || \
(echo "uv is required. Run 'make install' or 'make install-uv' first." && exit 1)
uv lock --check $(PYTHON_ARG)
17 changes: 17 additions & 0 deletions mkdocs/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,23 @@ For full control over your environment, you can use uv commands directly. See th
- Running commands with `uv run`
- Lock file management with `uv.lock`

### Lock File Management

`uv.lock` is a cross-platform lockfile that contains exact information about the project's dependencies.
See the [uv.lock documentation](https://docs.astral.sh/uv/guides/projects/#uvlock) for more details.

When modifying dependencies in `pyproject.toml`, regenerate the lock file:

```bash
make uv-lock
```

Separately, to verify that the lock file is up to date without modifying it:

```bash
make uv-lock-check
```

## Installation from source

Clone the repository for local development:
Expand Down