805 commits

Author	SHA1	Message	Date
Zanie Blue	2105b8a89d	Minor touchups to the Docker provenance docs (#11252)	2025-02-05 17:09:15 +00:00
Zanie Blue	1f963d1b89	Move content from the mkdocs.public.yml into the template (#11246) ... Closes https://github.com/astral-sh/uv/issues/11242	2025-02-05 16:13:46 +00:00
Zanie Blue	acbbb2b82a	Add --bare option to uv init (#11192) ... People are looking for a less opinionated version of `uv init`. The goal here is to create a `pyproject.toml` and nothing else. With the `--lib` or `--package` flags, we'll still configure a build backend but we won't create the source tree. This disables things like the default `description`, author behavior, and VCS. See - https://github.com/astral-sh/uv/issues/8178 - https://github.com/astral-sh/uv/issues/7181 - https://github.com/astral-sh/uv/issues/6750	2025-02-05 10:12:27 -06:00
Zanie Blue	989b103171	Add support for respecting VIRTUAL_ENV in project commands via --active (#11189) ... I think `UV_PROJECT_ENVIRONMENT` is too complicated for use-cases where the user wants to sync to the active environment. I don't see a compelling reason not to make opt-in easier. I see a lot of questions about how to deal with this warning in the issue tracker, but it seems painful to collect them here for posterity. A notable behavior here — we'll treat this as equivalent to `UV_PROJECT_ENVIRONMENT` so... if you point us to a valid virtual environment that needs to be recreated for some reason (e.g., new Python version request), we'll happily delete it and start over.	2025-02-05 10:12:19 -06:00
Charlie Marsh	fea00dcdd5	Bump version to v0.5.28 (#11228)	2025-02-04 20:28:43 -05:00
Martijn Pieters	04374b03cc	Docs on how to verify uv docker image attestations (#11140) ... As [requested by @zanieb](https://github.com/astral-sh/uv/pull/8685#issuecomment-2627556992).	2025-02-04 15:38:19 -06:00
konsti	d9907f6fda	Update resolver internals docs (#11098) ... Since the resolver internals docs were written, we added a lot more features to the resolver, which should be documented. As usual, these docs are not targeted at regular users, but should give interested readers an insight into the internals of uv and help advanced users with especially hard resolver problems.	2025-02-04 13:06:27 +00:00
FishAlchemist	49b85d2e65	Add `last updated` for document (#11164) ... ## Summary   Display the last document update time, excluding any automatically generated parts of the document, while ensuring that Google can accurately read and recognize the webpage's time. Note that I do not have permission to update ``requirements-insiders.txt`` Google time info * https://developers.google.com/search/blog/2019/03/help-google-search-know-best-date-for * https://developers.google.com/search/docs/appearance/structured-data/article#amp Similar https://github.com/astral-sh/uv/pull/11162 Closes #11148 ## Test Plan uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.public.yml --strict  The correct format is actually ``2024-08-08T22:01:08Z``, but Google Search happens to be lenient and accepts this format. 	2025-02-03 22:28:47 -05:00
Zanie Blue	73e9928d40	Bump version to 0.5.27 (#11201)	2025-02-03 16:55:36 -06:00
Gregory Power	f54979f2bc	add instructions for deactivating an environment (#11200) ... ## Summary Add instructions for deactivating a virtual environment. --------- Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-02-03 22:16:41 +00:00
Zanie Blue	1be8ba7df1	Add best-practice flags to pip install example in troubleshooting guide (#11194)	2025-02-03 20:13:55 +00:00
Charlie Marsh	2dfeafbaa4	Set UV_PYTHON in Jupyter kernels (#11155) ... ## Summary It turns out activating the kernel does not change `VIRTUAL_ENV`, so we still install into the environment the Jupyter environment, rather than the project environment. Unfortunately, after this change, we do still show a warning on `uv add`: ``` warning: `VIRTUAL_ENV=/Users/crmarsh/.cache/uv/archive-v0/3bddKDdYXuX2w57Fu6itL` does not match the project environment path `.venv` and will be ignored ``` `uv pip install` works without warning. Closes #11154.	2025-02-01 16:54:34 -05:00
Charlie Marsh	1fae8dbf17	Add Git SHA locking behavior to docs (#11125) ... ## Summary Closes https://github.com/astral-sh/uv/issues/11090.	2025-01-31 12:11:04 -06:00
Zanie Blue	5ef3d51390	Bump version to 0.5.26 (#11119)	2025-01-30 15:37:00 -06:00
Zanie Blue	e0a19be825	Touch-ups to the Python install guide (#11116)	2025-01-30 13:56:53 -06:00
konsti	80d485d32a	Explain build frontend vs. build backend (#11094) ... We regularly get questions why `uv build` is missing certain files or using the wrong build tag, when that's done by the build backend and part of the build backend's docs. I tried to clarify this difference and to redirect users to look at the tool's docs instead of wondering why uv's docs don't explain that. --------- Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com> Co-authored-by: Zanie Blue <contact@zanie.dev>	2025-01-30 19:48:47 +00:00
Charlie Marsh	7531bb8669	Upgrade PyTorch version in documentation (#11114) ... ## Summary PyTorch 2.6.0 is now GA!	2025-01-30 14:05:13 -05:00
Charlie Marsh	658ca89fb1	Use sys_platform in lieu of platform_system in PyTorch docs (#11113) ... ## Summary This is what we use in the lockfile. I believe it's preferable, and it's also more concise.	2025-01-30 19:01:52 +00:00
Charlie Marsh	9f8cd92bd3	Use positive (rather than negative) markers in PyTorch examples (#11112) ... ## Summary Maybe slightly controversial because it's more verbose, but we really want to limit these indexes to Linux and Windows, rather than ignoring them on Darwin. E.g., we'd also want to ignore them on other platforms. Further down, I use markers that look like this in the more complete examples, so this feels more consistent.	2025-01-30 14:00:35 -05:00
Charlie Marsh	70507b7898	Add PyTorch XPU instructions to the PyTorch guide (#11109) ... ## Summary Closes https://github.com/astral-sh/uv/issues/11079.	2025-01-30 13:48:52 -05:00
Zanie Blue	220821bc39	Add support for uvx python (#11076) ... Supersedes https://github.com/astral-sh/uv/pull/7491 Closes https://github.com/astral-sh/uv/issues/7430 Thanks @mikeleppane for starting this implementation. I took a bit of a different approach and it was easier to start over fresh, but I used some of the test cases there.	2025-01-30 11:53:58 -06:00
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