docs installation.md: describe how to pass options to the installer on Linux#6839
Merged
zanieb merged 3 commits intoastral-sh:mainfrom Sep 17, 2024
Merged
docs installation.md: describe how to pass options to the installer on Linux#6839zanieb merged 3 commits intoastral-sh:mainfrom
installation.md: describe how to pass options to the installer on Linux#6839zanieb merged 3 commits intoastral-sh:mainfrom
Conversation
… on Linux I'd feel more comfortable using the installer with the instructions in this commit, since I'm uncomfortable with random scripts trying to modify my system config (PATH in this case). Currently, the installer seems to be the best way to install `uv` that allows updating it on a system without Homebrew or `pipx`. I hope somebody will provide similar instructions for Windows. I considered recommending saving the script to a file and then running that, but I think it's better to have fewer options in the instructions. Most people who'd want to save the file would figure it out. As an aside, I would personally appreciate if `uv` could be installed easily with `cargo install` or `cargo binstall`, but a friendly script that acts predictably is probably more useful for more people.
Contributor
Author
|
Thinking some more about my motivations: if One more thing I tested is that if I run and then run Given that, getting the regular |
zanieb
pushed a commit
that referenced
this pull request
Sep 7, 2024
I find this more readable; it also no longer requires bash (thought just replacing `bash` with `sh` would achieve that much). Strictly speaking, `env` is not necessary on most shells, but I find it makes things clearer. ## Test Plan Ran the command locally, did not try compiling the docs. ---------- Aside, loosely related (and hopefully helpful) suggestions: I'm hoping you will also explain in the docs how to install to `~/.local/bin`, with the same goal as #6839. Using environment variables for that is fine. Another minor FR I'd have is to mention these environment variables in the help message of the installer script, especially if you want to encourage people to use them. Thank you for working on the installation script! It helps me feel more comfortable about eventually asking that people install `uv` to compile docs on my project, hopefully helping people who don't have a Python environment already installed.
Member
|
Thanks! |
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Sep 21, 2024
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.4.9` -> `0.4.13` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.4.13`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0413) [Compare Source](astral-sh/uv@0.4.12...0.4.13) ##### Enhancements - Add `socks` support ([#​7503](astral-sh/uv#7503)) - Avoid warning about bad Python interpreter links for empty project environment directories ([#​7527](astral-sh/uv#7527)) - Improve invalid environment warning messages ([#​7544](astral-sh/uv#7544)) - Use more verbose spelling of "virtualenv" during creation ([#​7523](astral-sh/uv#7523)) - Do not use a user-facing warning for "Waiting to acquire lock..." message ([#​7502](astral-sh/uv#7502)) ##### Performance - Use a single buffer for hints on resolver errors ([#​7497](astral-sh/uv#7497)) ##### Bug fixes - Allow Python pre-releases to be used if they are first on the `PATH` ([#​7470](astral-sh/uv#7470)) - Avoid deleting the project environment directory if it is not a virtual environment ([#​7522](astral-sh/uv#7522)) - Do not error if the `CACHEDIR.TAG` file exists but cannot be written to ([#​7550](astral-sh/uv#7550)) - Treat invalid platform as more compatible than invalid Python ([#​7556](astral-sh/uv#7556)) - Use portable paths when serializing sources ([#​7504](astral-sh/uv#7504)) - Compute resolver hints using the final reduced derivation tree ([#​7546](astral-sh/uv#7546)) - Bump the wheel and sdist cache versions ([#​7560](astral-sh/uv#7560)) - Heal cache entries with missing source distributions ([#​7559](astral-sh/uv#7559)) ##### Rust libraries - Bump minimum supported Rust version from 1.80 -> 1.81 ##### Documentation - Add `UV_LINK_MODE` to Docker caching example ([#​7510](astral-sh/uv#7510)) - Clarify behavior of of overrides in CLI reference ([#​7537](astral-sh/uv#7537)) ### [`v0.4.12`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0412) [Compare Source](astral-sh/uv@0.4.11...0.4.12) ##### Enhancements - Allow users to provide pre-defined metadata for resolution ([#​7442](astral-sh/uv#7442)) - Invalidate existing tool environments on Python interpreter mismatch ([#​7451](astral-sh/uv#7451)) ##### Bug fixes - Avoid fatal error when searching for egg-info with missing directory ([#​7498](astral-sh/uv#7498)) ##### Documentation - Add note on cache growth for self-hosted GitHub runners ([#​5757](astral-sh/uv#5757)) ### [`v0.4.11`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0411) [Compare Source](astral-sh/uv@0.4.10...0.4.11) ##### Enhancements - Add `--no-editable` support to `uv sync` and `uv export` ([#​7371](astral-sh/uv#7371)) - Add support for `--only-dev` to `uv sync` and `uv export` ([#​7367](astral-sh/uv#7367)) - Add support for remaining pip-supported file extensions ([#​7387](astral-sh/uv#7387)) - Generate shell completion for `uvx` ([#​7388](astral-sh/uv#7388)) - Include `uv export` command in `requirements.txt` output ([#​7374](astral-sh/uv#7374)) - Prune unzipped source distributions in `uv cache prune --ci` ([#​7446](astral-sh/uv#7446)) - Warn when trying to `uv sync` a package without build configuration ([#​7420](astral-sh/uv#7420)) - Support requests for pre-releases in the `--python` option ([#​7335](astral-sh/uv#7335)) ##### Bug fixes - Avoid erroneous version warning for `.dist-info` directories ([#​7444](astral-sh/uv#7444)) - Avoid removing seed packages for `uv venv --seed` environments ([#​7410](astral-sh/uv#7410)) - Avoid unnecessary progress bar initializations ([#​7412](astral-sh/uv#7412)) - Error when `tool.uv.sources` contains duplicate package names ([#​7383](astral-sh/uv#7383)) - Include `--branch` et al when resolving unnamed URLs in `uv add` ([#​7447](astral-sh/uv#7447)) - Include `dev-dependencies` in `--no-sources` invocations ([#​7408](astral-sh/uv#7408)) - Include the parent interpreter in Python discovery when `--system` is used ([#​7440](astral-sh/uv#7440)) - Respect `--no-sources` in PEP 723 scripts ([#​7409](astral-sh/uv#7409)) - Respect `pyproject.toml` credentials from user-provided requirements ([#​7474](astral-sh/uv#7474)) - Use consistent PyPI cache bucket ([#​7443](astral-sh/uv#7443)) - Use unambiguous relative paths in `uv export` ([#​7378](astral-sh/uv#7378)) ##### Documentation - Add documentation on platform-specific dependencies ([#​7411](astral-sh/uv#7411)) - Add documentation for passing installer options on Linux ([#​6839](astral-sh/uv#6839)) - Separate project data from configuration settings ([#​7053](astral-sh/uv#7053)) ##### Error messages - Hint at missing `project.name` ([#​6803](astral-sh/uv#6803)) - Surface dedicated `project.name` error for workspaces ([#​7399](astral-sh/uv#7399)) - Remove duplicate warning for settings discovery errors ([#​7384](astral-sh/uv#7384)) ### [`v0.4.10`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0410) [Compare Source](astral-sh/uv@0.4.9...0.4.10) ##### Enhancements - Allow `uv tool upgrade --all` to continue on individual upgrade failure ([#​7333](astral-sh/uv#7333)) - Support globs as cache keys in `tool.uv.cache-keys` ([#​7268](astral-sh/uv#7268)) - Add Python package (`__main__.py`) support to `uv run` ([#​7281](astral-sh/uv#7281)) - Add zip application support to `uv run` ([#​7289](astral-sh/uv#7289)) - Add `--token` option to `self update` command ([#​7279](astral-sh/uv#7279)) ##### Performance - Use `globwalk` for `cache-keys` matching ([#​7337](astral-sh/uv#7337)) ##### Bug fixes - Always treat archive-like requirements as local files ([#​7364](astral-sh/uv#7364)) - Apply `--no-install` options when constructing resolution ([#​7277](astral-sh/uv#7277)) - Avoid clobbering existing `py.typed` files contents in `uv init` ([#​7338](astral-sh/uv#7338)) - Avoid enforcing platform compatibility when validating lockfile ([#​7305](astral-sh/uv#7305)) - Avoid installing transitive dev dependencies ([#​7318](astral-sh/uv#7318)) - Avoid selecting prerelease Python installations without opt-in ([#​7300](astral-sh/uv#7300)) - Fix PPC64 page size in binary builds. ([#​7298](astral-sh/uv#7298)) - Include pre-release Python versions in `uv python list` ([#​7290](astral-sh/uv#7290)) - Make version ID optional for source builds ([#​7362](astral-sh/uv#7362)) - Support relative paths in `uv add --script` ([#​7301](astral-sh/uv#7301)) ##### Documentation - Fix documentation typos for `uv build --build-constraint` flag ([#​7330](astral-sh/uv#7330)) - Fix grammatical error in CLI docs ([#​7353](astral-sh/uv#7353)) ##### Error messages - Add dedicated lock errors for wheel-only distributions ([#​7307](astral-sh/uv#7307)) - Avoid treating `.whl` sources as source distributions ([#​7303](astral-sh/uv#7303)) - Clarify Python requirement source for script incompatibilities ([#​7339](astral-sh/uv#7339)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(This is a suggestion that was easy for me to make a PR for; if other approaches are considered better, feel free to consider this as a FR for those instead)
I'd feel more comfortable using the installer with the instructions in this commit, since I'm uncomfortable with random scripts trying to modify my system config (PATH in this case).
Currently, the installer seems to be the best way to install
uvthat allows updating it on a system without Homebrew orpipx. I hope somebody will provide similar instructions for Windows.I considered recommending saving the script to a file and then running that, but I think it's better to have fewer options in the instructions. Most people who'd want to save the file would figure it out.
As an aside, I would personally appreciate if
uvcould be installed easily withcargo installorcargo binstall, but a friendly script that acts predictably is probably more useful for more people.Test Plan
I tested the command on my machine, but I did not test compiling the docs (yet). If the CI does not compile the docs, I could test this a bit later, or perhaps this would be easier for somebody who already has a dev environment set up.