Commit Graph

235 Commits

Author SHA1 Message Date
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
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
(https://github.com/astral-sh/uv/commit/f5add0ca5e2711396e033741375049d0454730f4),
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
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
sergue1 15e20501d1 typo (#10538)
fix typo in docs
2025-01-12 09:07:04 -06:00
Charlie Marsh 27d1bad550 Bump version to v0.5.18 (#10499) 2025-01-11 14:38:26 +00:00
Charlie Marsh c198e2233e Bump version to v0.5.17 (#10480) 2025-01-10 15:52:56 -05:00
Charlie Marsh 129a75e2d0 Add meta descriptions for remaining guides (#10450)
## Summary

Closes https://github.com/astral-sh/uv/issues/10418.
2025-01-09 17:39:00 -05:00
Charlie Marsh d77598a08c Use Windows-specific instructions in Jupyter guide (#10446)
## Summary

Closes https://github.com/astral-sh/uv/issues/10407.
2025-01-09 16:43:09 -05:00
Charlie Marsh 19589e0614 Add meta descriptions for some guides (#10421)
## Summary

Part of: https://github.com/astral-sh/uv/issues/10418.
2025-01-09 15:50:16 +00:00
Charlie Marsh 58a81f7c47 Add uv lock --script to the docs (#10414) 2025-01-08 19:33:55 -05:00
Charlie Marsh 2e0d7429ef Add Lambda layer instructions to AWS Lambda guide (#10411)
## Summary

Closes https://github.com/astral-sh/uv/issues/10406.
2025-01-08 22:12:52 +00:00
Charlie Marsh 333f03f112 Bump version to v0.5.16 (#10395) 2025-01-08 10:29:32 -05:00
Charlie Marsh 4c0922ee1b Add AWS Lambda integration guide (#10278)
## Summary

This includes instructions to:

- Deploy a standalone application.
- Deploy an application that depends on local libraries (a workspace).
- Deploy via Docker.
- Deploy via zip.

There's an accompanying Git repository here:
https://github.com/astral-sh/uv-aws-lambda-example.

Closes https://github.com/astral-sh/uv/issues/8935.
2025-01-07 13:50:31 -05:00
csteiner 788df24460 docs: github actions example: remove unneeded install step (#10356)
* Previously had uv python install, then uv sync --all-extras --dev
* If we are going to use sync for dev dependencies, then the install
step is unneccessary

<!--
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-07 08:46:44 -05:00
Zanie Blue eb6ad9a4fa Bump version to 0.5.15 (#10337) 2025-01-06 18:04:25 -06:00
Charlie Marsh 09de67039b Tweak script --no-project comment (#10331) 2025-01-06 13:41:44 -05:00
Charlie Marsh 9f1ba2b967 Bump version to v0.5.14 (#10279) 2025-01-02 14:31:04 -05:00
Charlie Marsh 4c49683f7b Bump version to v0.5.13 (#10188) 2024-12-26 23:58:13 +00:00
Charlie Marsh 351d602d86 Bump version to v0.5.12 (#10175) 2024-12-26 14:16:19 -05:00
renovate[bot] dae551d8d8 Update documentation references to astral-sh/setup-uv to v5 (#10117) 2024-12-23 08:47:28 -05:00
Charlie Marsh 2c68dfd4a9 Backtrack to non-local versions when wheels are missing platform support (#10046)
## Summary

This is yet another variation on
https://github.com/astral-sh/uv/pull/9928, with a few minor changes:

1. It only applies to local versions (e.g., `2.5.1+cpu`).
2. It only _considers_ the non-local version as an alternative (e.g.,
`2.5.1`).
3. It only _considers_ the non-local alternative if it _does_ support
the unsupported platform.
4. Instead of failing, it falls back to using the local version.

So, this is far less strict, and is effectively designed to solve
PyTorch but nothing else. It's also not user-configurable, except by way
of using `environments` to exclude platforms.
2024-12-20 19:11:27 +00:00
Zanie Blue c4d0caaee5 Bump version to 0.5.11 (#10044) 2024-12-19 18:01:45 -06:00
Zanie Blue 8908e26de7 Add uv python install --preview to the documentation (#10010) 2024-12-19 16:07:46 -06:00
Zanie Blue 37b11ddb22 Bump version to 0.5.10 (#9983) 2024-12-17 14:53:19 -06:00
Zanie Blue d70160a57b Update references to python-build-standalone to reflect the transferred project (#9977) 2024-12-17 20:19:58 +00:00
Udi Oron f5add0ca5e docs: added pre-commit uv-lock and uv-export hooks to docs (#9872)
<!--
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? -->

---------

Co-authored-by: Jonne <jonne.haapalainen@gmail.com>
2024-12-16 13:38:57 -06:00
Zach Kurtz a8772c6944 clarify best practice for python matrix strategy github workflow (#9454)
<!--
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

Existing documentation on how to apply a matrix strategy over the python
version in a github workflow is incomplete and possibly misleading. This
PR deletes the existing section and creates a new one to reflect current
best practice. See https://github.com/astral-sh/uv/issues/9376.

## Test Plan

N/A, only docs.

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-12-16 13:38:06 -06:00
Jim Kutter e925787da3 change example so it works as is on powershell and cmd (#9903)
<!--
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

When going through the docs at
https://docs.astral.sh/uv/guides/install-python/#automatic-python-downloads,
when you try to copy and paste the example on Windows, in either
PowerShell or cmd.exe the example won't work.

Inverting the quotes fixes it, and still works on other shells (I only
tried bash under wsl)

## Test Plan

On any windows system, from powershell, running the example yields the
following error:

```
> uv run --python 3.12 python -c 'print("hello world")'
  File "<string>", line 1
    print(hello world)
          ^^^^^^^^^^^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
```

on cmd.exe

```
> uv run --python 3.12 python -c 'print("hello world")'

``` 
(there is no output)

Inverting the quotes on powershell
```
> uv run --python 3.12 python -c "print('hello world')"
hello world
```

on cmd.exe
```
> uv run --python 3.12 python -c "print('hello world')"
hello world


```

<!-- How was it tested? -->
2024-12-15 11:19:44 -06:00
Charlie Marsh 0652800cb0 Bump version to v0.5.9 (#9889) 2024-12-13 17:28:19 -05:00
Zanie Blue 80d41671bc Bump version to 0.5.8 (#9791) 2024-12-11 15:18:51 +00:00
konsti 321101d340 Publish: Support --index <name> (#9694)
When publishing, we currently ask the user to set `--publish-url` to the
upload URL and `--check-url` to the simple index URL, or the equivalent
configuration keys. But that's redundant with the `[[tool.uv.index]]`
declaration. Instead, we extend `[[tool.uv.index]]` with a `publish-url`
entry and allow passing `uv publish --index <name>`.

`uv publish --index <name>` requires the `pyproject.toml` to be present
when publishing, unlike using `--publish-url ... --check-url ...` which
can be used e.g. in CI without a checkout step. `--index` also always
uses the check URL feature to aid upload consistency.

The documentation tries to explain both approaches together, which
overlap for the check URL feature.

Fixes #8864

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-12-10 22:17:47 +01:00
Zanie Blue 3ca155ddd6 Bump version to 0.5.7 (#9698) 2024-12-06 17:50:21 -06:00
Konstantinos 7d1308876e Docs(GitLab): add entrypoint for distroless image (#9093)
## Summary

Update the docs for the GitLab integration, to make it clear that an
entrypoint has to be specified, when a distroless image is being used.

## Test Plan

Without specifying an entrypoint when using a distroless image:

<img
src=https://github.com/user-attachments/assets/35499bd5-51d8-4016-b1d0-2d56956f82e6
width=500>

_It works if you either specify the entrypoint or if the image used in
not a distroless one._

Co-authored-by: Tsafaras <konstantinos@valuechecker.ai>
2024-12-03 18:19:05 -06:00
Zanie Blue 59460b8a7c Bump version to 0.5.6 (#9612) 2024-12-03 14:13:06 -06:00
Zanie Blue 95cd8b8b3f Bump version to 0.5.5 (#9478) 2024-11-27 11:37:39 -06:00
renovate[bot] a17c04730f Update documentation references to astral-sh/setup-uv to v4 (#9408) 2024-11-24 20:49:09 -05:00
Charlie Marsh c62c83c37a Bump version to v0.5.4 (#9290) 2024-11-20 16:01:24 -05:00
Zanie Blue 4f65a69ebf Move the integration guides into the "Guides" section as a collapsed group (#9245)
Let's have all the guides together!
2024-11-20 08:50:02 -06:00
Charlie Marsh c188b11b0a Fix typo in PyTorch docs (#9249)
## Summary

Raised at https://x.com/stefanofusai/status/1858981714942718163/photo/1.
2024-11-19 15:41:30 -06:00
Charlie Marsh b09d5fcdd9 Add minimum version to PyTorch guide (#9247)
## Summary

Closes https://github.com/astral-sh/uv/issues/9224.
2024-11-19 15:21:43 -06:00
Zanie Blue ca9aaf1c48 Reorganize the project concept documentation (#9121)
- Adds a collapsible section for the project concept
- Splits the project concept document into several child documents.
- Moves the workspace and dependencies documents to under the project
section
- Adds a mkdocs plugin for redirects, so links to the moved documents
still work

I attempted to make the minimum required changes to the contents of the
documents here. There is a lot of room for improvement on the content of
each new child document. For review purposes, I want to do that work
separately. I'd prefer if the review focused on this structure and idea
rather than the content of the files.

I expect to do this to other documentation pages that would otherwise be
very nested.

The project concept landing page and nav (collapsed by default) looks
like this now:

<img width="1507" alt="Screenshot 2024-11-14 at 11 28 45 AM"
src="https://github.com/user-attachments/assets/88288b09-8463-49d4-84ba-ee27144b62a5">
2024-11-19 13:52:12 -06:00
Charlie Marsh 56d3622087 Bump version to v0.5.3 (#9229) 2024-11-19 18:53:54 +00:00
Charlie Marsh dea2a040f0 Add documentation for using uv with PyTorch (#9210)
## Summary

Now that we have all the pieces in place, this PR adds some dedicated
documentation to enable a variety of PyTorch setups.

This PR is downstream of #6523 and builds on the content in there; #6523
will merge first, and this PR will follow.
2024-11-19 01:09:52 +00:00
baggiponte a88a3e5eba docs: Add PyTorch installation guide (#6523)
Hello there! First real docs PR for uv.

1. I expect this will be rewritten a gazillion times to have a
consistent tone with the rest of the docs, despite me trying to stick to
it as best as I could. Feel free to edit!
2. I went super on the verbose mode, while also providing a callout with
a TLDR on top. Scrap anything you feel it's redundant!
3. I placed the guide under `integrations` since Charlie added the
FastAPI integration there.

## Summary

<!-- What's the purpose of the change? What does it do, and why? -->
Addresses #5945

## Test Plan

<!-- How was it tested? -->
I just looked at the docs on the dev server of mkdocs if it looked nice.

**I could not test the commands that I wrote work** outside of macOS. If
someone among contributors has a Windows/Linux laptop, it should be
enough, even for the GPU-supported versions: I expect the installation
will just break once torch checks for CUDA (perhaps even at runtime).

---------

Co-authored-by: Santiago Castro <bryant1410@gmail.com>
Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
2024-11-18 20:02:55 -05:00
Zanie Blue 195f4b634f Bump version to 0.5.2 (#9133) 2024-11-14 15:59:50 -06:00