884 commits

Author	SHA1	Message	Date
Danilo Rezende	eb8ffa4981	Update documentation for running in a container (#11052) ... This PR rewords the instructions for using uv in a container. I'm a new user and was somewhat confused by it, so I've rewritten it as I'd have liked to have read it. It makes it more clear what distroless means, to avoid confusion with other projects that ship OS files with an image with its tag name clear of qualifiers(`astral-sh/uv`, in this case). An example of that is caddy, which ships with alpine. This also modifies the original example to use a distroful image instead of distroless one while #8635 doesn't get resolved. --------- Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-30 00:17:58 +00:00
Zanie Blue	a3049ecf69	Fix broken link (#11081)	2025-01-29 19:41:18 +00:00
Zanie Blue	2ca51501ed	Shorten "Using existing Python versions" nav item so it fits on one line (#11077)	2025-01-29 19:04:11 +00:00
Florian Greinacher	9fc24b2ac5	docs: suggest copy linking for GitLab integration guide (#11067) ... ## Summary Hardlinking does not work in that context and raises a warning. Setting the link mode to copy makes the warning go away. ## Test Plan Tested on gitlab.com and our self-hosted GitLab instance. Before changing the link mode: 8986967570 After changing the link mode: 8987026307. ⚒️ with ❤️ by [Siemens](https://opensource.siemens.com/) --------- Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-29 17:58:14 +00:00
titipoco	3af3af5039	Fix typo in no-deps docs/comments/cli description (#11073) ... ## Summary Fixes a recurring typo. ## Details There's a typo appearing in a particular sentence... > Ignore package dependencies, instead only add those packages explicitly listed on the command line to the resulting **the** requirements file. ... used in: * `crates/uv-cli/src/lib.rs` * `crates/uv-settings-src-settings.rs` * `docs/reference/settings.md` * `uv.schem.json` Docs, comments and a CLI command description seem affected. This PR fixes it. --------- Co-authored-by: bujnok01 <bujnok01@heiway.net>	2025-01-29 11:55:40 -06:00
Zanie Blue	48976e12e8	Add docs for signal handling (#11041) ... I'm not sure if this should go in the CLI reference or not? but here seems like an okay start. I want to figure out a way to avoid repeating this content.	2025-01-29 08:27:52 -06:00
Zanie Blue	7633f1db83	Reflow CLI documentation comments (#11040) ... I'm sorry, but I was writing some new content here and the inconsistent wrapping was very hard to maintain and I didn't want to muddy the diff there with reflowing. I don't think we need to be strict about the reflow (I'm not sure we even can be) but some of these were very far off from our typical wrap length.	2025-01-29 08:21:32 -06:00
Marco Barbosa	c5ccea2bb1	doc typo: unnecessary backslashes to represent brackets in markdown (#11059) ... There is a small typo in the doc which could mislead users: reference to a table in `pyproject.toml` currently appears as [`\[project.entry-points\]`](https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#using-package-metadata) while it should be [`[project.entry-points]`](https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#using-package-metadata). Backslashes are appearing because they weren't supposed to be used on code representation in Markdown.	2025-01-29 08:17:31 -06:00
Bob Whitelock	baec42c494	Update Dependabot links (#11054) ... ## Summary The latter issue has been closed in favour of the former, so just link the one issue Dependabot is using to track this. ## Test Plan N/A --- Thanks!	2025-01-29 08:06:08 -06:00
Victorien	7868d5df95	Fix formatting of RUST_LOG documentation (#10053) ... <!-- Thank you for contributing to uv! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary <!-- What's the purpose of the change? What does it do, and why? --> ## Test Plan <!-- How was it tested? -->	2025-01-28 17:31:10 -06:00
Zanie Blue	9c07c3fc5b	Bump version to 0.5.25 (#11042)	2025-01-28 15:40:43 -06:00
Charlie Marsh	566f0d0abd	Add Requires-Python upper bound behavior to the docs (#10964) ... ## Summary Closes https://github.com/astral-sh/uv/issues/10376.	2025-01-28 12:17:34 -05:00
Charlie Marsh	92b72c62ea	Amend requires-python rules in resolver documentation (#10993) ... ## Summary Closes https://github.com/astral-sh/uv/issues/10967.	2025-01-28 12:17:27 -05:00
Zanie Blue	71f0798536	Add a troubleshooting section and reproducible example guide (#10947) ... Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com>	2025-01-27 13:29:23 -06:00
Cédric	315fc1792a	Update documentation for activating virtual environments in different shell (#11000) ... ## Add activation commands for fish shell and other alternative shells While trying to use uv with fish shell, I encountered an issue as `source .venv/bin/activate` didn't work. The documentation didn't specify that fish shell requires using `source .venv/bin/activate.fish` instead. I created issue #10986 to address this. This PR improves the documentation by: - Adding the correct activation command for fish shell: `source .venv/bin/activate.fish` - Adding the correct activation command for Nushell: `use .venv\Scripts\activate.nu` - Adding the correct activation command for Tcsh: `use .venv/bin/activate.csh` This will help users of alternative shells to properly activate their virtual environments without encountering the same confusion I experienced. Fixes #10986 --------- Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-27 19:24:47 +00:00
Charlie Marsh	f1c02182b7	Reference workspaces in --no-sources documentation (#10995) ... ## Summary See: https://github.com/astral-sh/uv/issues/10991#issuecomment-2616543018	2025-01-27 13:33:14 -05:00
Ryan	90a4178c7a	[docs/integration/docker] add sha pinning tip (#10955) ... <!-- Thank you for contributing to uv! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary <!-- What's the purpose of the change? What does it do, and why? --> As requested in https://github.com/astral-sh/uv/issues/6565, this adds a tip discussing the ability to pin the image to a specific SHA digest and why it may be useful. ## Test Plan <!-- How was it tested? --> Start serving the documentation locally ```shell uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.public.yml ``` Then navigate to http://127.0.0.1:8000/uv/guides/integration/docker/ to see the tool tip being rendered properly --------- Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-27 18:29:23 +00:00
Paul	e8d6b330a3	tiny typo (duplicate word) (#10959) ... Fix an apparent typo	2025-01-25 10:30:10 -06:00
Zanie Blue	6e4845fffb	Add documentation for uv add -r (#10926) ... Closes https://github.com/astral-sh/uv/issues/10924	2025-01-23 21:34:50 -06:00
Zanie Blue	42fae925c4	Bump version to 0.5.24 (#10922)	2025-01-23 17:26:59 -06:00
Aria Desires	c05aca61db	temporarily disable new uv pip dependency-group flags (#10909) ... We'll probably end up shipping but we were moving ahead with this on the basis that pip may not even ship this, so let's play it safe and wait for a bit.	2025-01-23 14:43:07 -06:00
Jo	a497176818	Improve some env var document (#10887)	2025-01-23 09:10:19 -05:00
Mathieu Kniewallner	e3a09888ab	docs(git): add subdirectory example (#10894) ... ## Summary Closes #10889. As kinda hinted in the issue, would adding a `--subdirectory` flag to `uv add` make sense? This would IMO be more discoverable. ## Test Plan Ran the command added to the documentation: ```console $ uv add git+https://github.com/langchain-ai/langchain#subdirectory=libs/langchain Resolved 40 packages in 203ms Built langchain @ git+https://github.com/langchain-ai/langchain@f2ea62f63209130bfc56b1fe7d0fa7c299bbf352#subdirectory=libs/langchain Prepared 19 packages in 837ms Installed 37 packages in 14ms [...] ```	2025-01-23 08:58:39 -05:00
Aria Desires	53706a1864	Add dependency-group cli flags to uv pip install and uv pip compile (--group, --no-group, --only-group, --all-groups) (#10861) ... Ultimately this is a lot of settings plumbing and a couple minor pieces of Actual Logic (which are so simple I have to assume there's something missing, but maybe not!). Note this "needlessly" use DevDependencyGroup since it costs nothing, is more futureproof, and lets us maintain one primary interface (we just pass `false` for all the dev arguments). Fixes #8590 Fixes #8969	2025-01-23 08:47:52 -05:00
Charlie Marsh	ba42467f1b	Bump version to v0.5.23 (#10879)	2025-01-23 00:26:10 +00:00
Charlie Marsh	2df3f0e782	Reduce ambiguity in conflicting extras example (#10877) ... ## Summary Closes https://github.com/astral-sh/uv/issues/10378.	2025-01-22 19:09:49 -05:00
Charlie Marsh	a7166fff8a	Add --refresh to uv venv (#10834) ... ## Summary I was surprised that this didn't exist.	2025-01-21 19:35:33 -05:00
Mathieu Kniewallner	1479f52be7	feat: add --no-default-groups flag (#10618) ... ## Summary Closes #10592. ## Test Plan Snapshot tests. --------- Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>	2025-01-21 18:03:17 -05:00
3sh V	cee8770cb0	Update pre-commit documentation (#10756) ... ## Summary Added missing `repos:` line to make the example config complete --------- Co-authored-by: Rajesh Veeranki <rveeranki@d4q74qfn2y.agoda.local> Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-21 22:46:18 +00:00
Charlie Marsh	4574ced370	Bump version to v0.5.22 (#10829)	2025-01-21 17:03:55 -05:00
Niklas Rosenstein	5ecfc3d900	Update docs on how to use UV_PROJECT_ENVIRONMENT to use the system python environment (#10817) ... ## Summary The docs did mention that you could set the `UV_PROJECT_ENVIRONMENT` variable to point Uv to use the system Python environment (e.g. for use in CI or Docker), but it did not document _how_. Reference: https://github.com/astral-sh/uv/pull/6834#issuecomment-2319253359 --------- Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-21 18:40:01 +00:00
Mathieu Kniewallner	7a14ea639e	docs: manually bump pre-commit refs (#10814) ... ## Summary rooster should pick those up, but those 2 references were added to 0.5.8 while a 0.5.9 was already released (f5add0ca5e), so they never got bumped automatically. I've searched for other cases like this in the documentation on other versions, just in case, and it seems that this is the only case.	2025-01-21 09:28:28 -05:00
Charlie Marsh	54bb5a38a4	Add invoke instructions to the AWS Lambda guide (#10805) ... ## Summary Closes https://github.com/astral-sh/uv/issues/10804.	2025-01-21 03:40:42 +00:00
Charlie Marsh	3478c068bb	Bump version to v0.5.21 (#10723)	2025-01-17 20:53:36 +00:00
Zanie Blue	e2da86ae09	Fix typo (#10720)	2025-01-17 12:54:14 -06:00
Zanie Blue	48140feacb	Add MACOSX_DEPLOYMENT_TARGET to the --python-platform documentation (#10698)	2025-01-17 18:49:00 +00:00
Se7en	d5b98fb76c	fix: links in configuring projects doc (#10710) ... <!-- Thank you for contributing to uv! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary <!-- What's the purpose of the change? What does it do, and why? --> Fix invalid links in [configuring projects](https://docs.astral.sh/uv/concepts/projects/config/#entry-points) doc. ## Test Plan <!-- How was it tested? -->	2025-01-17 12:39:56 -06:00
Charlie Marsh	1f29165796	Add UV_VENV_SEED environment variable (#10715) ... ## Summary Closes https://github.com/astral-sh/uv/issues/7655.	2025-01-17 12:08:55 -05:00
Charlie Marsh	4956c9a7a5	Add SyntaxWarning compatibility note to bytecode compilation docs (#10701)	2025-01-16 22:26:03 -05:00
Zanie Blue	33446091d2	Improve the styling of collapsible nav items (#10692) ... I've been a bit unhappy with the collapsible project section. I think it feels a little crowded and consequently hard to read. Here, we tweak the styling to decrease the font size a little and increase the margins. I aimed for a subtle change — we can change it more drastically later if we want. Before <img width="1414" alt="Screenshot 2025-01-16 at 12 35 38 PM" src="https://github.com/user-attachments/assets/820b87c6-2988-4170-87ae-cec9a0f3b4fb" /> After <img width="1414" alt="Screenshot 2025-01-16 at 12 35 16 PM" src="https://github.com/user-attachments/assets/0d0cdb6b-a6c6-4fe1-a7f2-48f6fd70d5bc" />	2025-01-16 15:02:43 -06:00
Mathieu Kniewallner	b46c6db317	docs: fix a few typos (#10675) ... ## Summary Fixing a few typos found in the documentation and in comments.	2025-01-16 09:53:59 -05:00
Charlie Marsh	1c17662b37	Bump version to v0.5.20 (#10659)	2025-01-15 23:18:06 +00:00
Zanie Blue	a7f13e0e0b	Bump version to 0.5.19 (#10643)	2025-01-15 20:56:43 +00:00
FishAlchemist	9736868908	Add meta titles to documents in guides, excluding integration documents. (#10539) ... ## Summary Add meta titles to documents in guides, excluding integration documents. <!-- What's the purpose of the change? What does it do, and why? --> ## Test Plan ``uvx --with-requirements docs/requirements.txt -- mkdocs build --strict -f mkdocs.public.yml`` <details> <summary>Build Result</summary> * ``guides/install-python`` ```html ... <meta name="description" content="Guide to install specific Python versions, manage existing installations, and automate downloads with uv."> ... <title>Install and Manage Python | uv</title> ... ``` * ``guides/projects`` ```html ... <meta name="description" content="Guide to create, manage, and build Python projects with uv, including dependencies and distributions."> ... <title>Working on projects | uv</title> ... ``` * ``guides/publish`` ```html ... <meta name="description" content="Guide to build and publish Python packages using uv"> ... <title>Publishing a package | uv</title> ... ``` * ``guides/scripts`` ```html ... <meta name="description" content="Run Python scripts quickly and manage dependencies efficiently using uv. Learn about inline metadata and more."> ... <title>Run Scripts | uv</title> ... ``` * ``guides/tools`` ```html ... <meta name="description" content="Guide to run, install, and upgrade Python tools using uv."> ... <title>Using tools | uv</title> ... ``` </details> --------- Co-authored-by: Charles Tapley Hoyt <cthoyt@gmail.com> Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-15 14:12:55 -06:00
Mel Massadian	66e47345cb	docs(workspaces): remove build-system (#10636) ... ## Summary Unless I'm doing something wrong, specifying `hatchling` as a build system here results in `ValueError: Unable to determine which files to ship` ## Test Plan Following the instructions of the document. ## Additional Don't hesitate to discard	2025-01-15 11:46:35 -06:00
Aria Desires	80ac8db7db	Always spawn a main2 thread to normalize main stack size issues (#10479) ... Also removes UV_STACK_SIZE and uses RUST_MIN_STACK instead, tweaking docs to reflect the differences. Fixes #10367	2025-01-14 22:35:17 -05:00
Aria Desires	692171c718	add --output-format=json flag to uv python list (#10596) ... <!-- Thank you for contributing to uv! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary I use `uv` for automation on remote hosts and it would be useful to have it be able to tell me the supported versions of python (for the remote machine) in a machine readable manner so I do not need to parse `uv python list`. This change adds `--format (json|text)` to `uv python list` to make it's output machine readable Loosely related: - https://github.com/astral-sh/uv/issues/411 ## Test Plan Manually tested via ``` # quick inspection without pretty print cargo run -- python list --format json ``` ### Short example of output (trimmed down) Cmd: `cargo run -- python list --format json | jq '.[:2]'` ```json [ { "key": "cpython-3.13.1+freethreaded-linux-x86_64-gnu", "version": "3.13.1", "version_parts": { "major": 3, "minor": 13, "patch": 1 }, "path": null, "symlink": null, "url": "20241219/cpython-3.13.1%2B20241219-x86_64-unknown-linux-gnu-freethreaded%2Bpgo%2Blto-full.tar.zst", "os": "linux", "variant": "freethreaded", "implementation": "cpython", "arch": "x86_64", "libc": "gnu" }, { "key": "cpython-3.13.1-linux-x86_64-gnu", "version": "3.13.1", "version_parts": { "major": 3, "minor": 13, "patch": 1 }, "path": "/usr/bin/python3.13", "symlink": null, "url": null, "os": "linux", "variant": "default", "implementation": "cpython", "arch": "x86_64", "libc": "gnu" } ] ``` --------- Co-authored-by: John Zlotek <jzlotek@gmail.com>	2025-01-14 11:47:49 -05:00
Eric Mark Martin	f261c65bdd	Implement pip freeze --path (#10488) ... ## Summary Resolves #5952 Add a `--path` option to `uv pip freeze` to be compatible with `pip freeze` ## Test Plan New snapshot tests --------- Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>	2025-01-13 22:50:04 +00:00
Sydney Duckworth	97c1877f6f	Add Git LFS support to uv-git crate (#10335) ... ## Summary Closes #3312. This PR adds Git LFS support to the `uv-git` crate by using the `git-lfs` CLI to fetch required LFS objects for a revision following the call to `git fetch`. The LFS fetch step is disabled by default and only enabled if the environment variable `UV_GIT_LFS` is set. When enabled, the LFS fetch step is run for all repositories regardless of whether they have associated LFS objects. The step is skipped if the `git-lfs` CLI tool isn't installed. ## Test Plan I verified that the minimal example in the linked issue passes, i.e. this command now succeeds: ```sh UV_GIT_LFS=1 uv pip install git+https://github.com/grebnetiew/lfs-py.git ``` I also verified that non-LFS repositories still work, with or without `git-lfs` installed. ### To Replicate Attempt to use uv to install a Git dependency that contains LFS objects (e.g. `uv pip install git+https://github.com/grebnetiew/lfs-py.git`). This should fail with a smudge filter error. Re-run the same command with the added environment variable `UV_GIT_LFS=1`. The install should now succeed. ## Potential Changes / Improvements ~With this change LFS objects in a given revision will always be downloaded if the user has Git LFS installed, which may not always be desired behavior. It might be helpful to add a field to the `uv` settings and/or an environment variable so that the LFS step can be disabled if needed.~ Enabling/disabled via environment variable has now been implemented. --------- Co-authored-by: Sydney Duckworth <sydduckworth@users.noreply.github.com> Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-13 21:48:06 +00:00
sergue1	15e20501d1	typo (#10538) ... fix typo in docs	2025-01-12 09:07:04 -06:00