Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(docs): adjust link (#1434) 

## What

Fixes a missing link in `contributing.md` to the Python installation
section by rearranging the section and adding a 3rd-level heading for
#Python

## Closes

Closes #1431
This commit is contained in:
Jacob Coffee 2024-02-16 08:24:29 -06:00 committed by GitHub
parent d99c4cacdf
commit 7f5415fd47
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -31,10 +31,14 @@ See the [Python](#python) section for instructions on installing the Python vers
### Windows
You can install CMake from the [installers](https://cmake.org/download/) or with `pipx install cmake` (make sure that the pipx install path is in `PATH`, pipx complains if it isn't).
You can install CMake from the [installers](https://cmake.org/download/) or with `pipx install cmake`
(make sure that the pipx install path is in `PATH`, pipx complains if it isn't).
## Testing
For running tests, we recommend [nextest](https://nexte.st/).
### Python
Testing uv requires multiple specific Python versions. You can install them into
`<project root>/bin` via our bootstrapping script:
@ -48,8 +52,6 @@ Alternatively, you can install `zstandard` from PyPI, then run:
python3.12 scripts/bootstrap/install.py
```
For running tests, we recommend [nextest](https://nexte.st/).
## Running inside a docker container
Source distributions can run arbitrary code on build and can make unwanted modifications to your system (https://moyix.blogspot.com/2022/09/someones-been-messing-with-my-subnormals.html, https://pypi.org/project/nvidia-pyindex/), which can even occur when just resolving requirements. To prevent this, there's a Docker container you can run commands in:
@ -63,7 +65,6 @@ docker run --rm -it -v $(pwd):/app uv-builder /app/target/x86_64-unknown-linux-m
We recommend using this container if you don't trust the dependency tree of the package(s) you are trying to resolve or install.
## Profiling
Please refer to Ruff's [Profiling Guide](https://github.com/astral-sh/ruff/blob/main/CONTRIBUTING.md#profiling-projects), it applies to uv, too.