mirror of
https://github.com/astral-sh/uv.git
synced 2025-12-23 09:19:48 +00:00
Move the "Export" guide to the projects concept section (#16835)
Some checks are pending
CI / Determine changes (push) Waiting to run
CI / lint (push) Waiting to run
CI / cargo clippy | ubuntu (push) Blocked by required conditions
CI / cargo clippy | windows (push) Blocked by required conditions
CI / cargo publish dry-run (push) Blocked by required conditions
CI / cargo dev generate-all (push) Blocked by required conditions
CI / cargo shear (push) Waiting to run
CI / cargo test | ubuntu (push) Blocked by required conditions
CI / cargo test | macos (push) Blocked by required conditions
CI / cargo test | windows (push) Blocked by required conditions
CI / check windows trampoline | aarch64 (push) Blocked by required conditions
CI / check windows trampoline | i686 (push) Blocked by required conditions
CI / check windows trampoline | x86_64 (push) Blocked by required conditions
CI / test windows trampoline | aarch64 (push) Blocked by required conditions
CI / test windows trampoline | i686 (push) Blocked by required conditions
CI / test windows trampoline | x86_64 (push) Blocked by required conditions
CI / typos (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / build binary | linux libc (push) Blocked by required conditions
CI / build binary | linux aarch64 (push) Blocked by required conditions
CI / build binary | linux musl (push) Blocked by required conditions
CI / build binary | macos aarch64 (push) Blocked by required conditions
CI / build binary | macos x86_64 (push) Blocked by required conditions
CI / build binary | windows x86_64 (push) Blocked by required conditions
CI / build binary | windows aarch64 (push) Blocked by required conditions
CI / build binary | msrv (push) Blocked by required conditions
CI / build binary | freebsd (push) Blocked by required conditions
CI / ecosystem test | pydantic/pydantic-core (push) Blocked by required conditions
CI / ecosystem test | prefecthq/prefect (push) Blocked by required conditions
CI / ecosystem test | pallets/flask (push) Blocked by required conditions
CI / smoke test | linux (push) Blocked by required conditions
CI / smoke test | linux aarch64 (push) Blocked by required conditions
CI / check system | alpine (push) Blocked by required conditions
CI / smoke test | macos (push) Blocked by required conditions
CI / smoke test | windows x86_64 (push) Blocked by required conditions
CI / smoke test | windows aarch64 (push) Blocked by required conditions
CI / integration test | activate nushell venv (push) Blocked by required conditions
CI / integration test | conda on ubuntu (push) Blocked by required conditions
CI / integration test | deadsnakes python3.9 on ubuntu (push) Blocked by required conditions
CI / integration test | free-threaded on windows (push) Blocked by required conditions
CI / integration test | aarch64 windows implicit (push) Blocked by required conditions
CI / integration test | aarch64 windows explicit (push) Blocked by required conditions
CI / integration test | windows python install manager (push) Blocked by required conditions
CI / integration test | pypy on ubuntu (push) Blocked by required conditions
CI / integration test | pypy on windows (push) Blocked by required conditions
CI / integration test | graalpy on ubuntu (push) Blocked by required conditions
CI / integration test | graalpy on windows (push) Blocked by required conditions
CI / integration test | pyodide on ubuntu (push) Blocked by required conditions
CI / integration test | github actions (push) Blocked by required conditions
CI / integration test | free-threaded python on github actions (push) Blocked by required conditions
CI / integration test | pyenv on wsl x86-64 (push) Blocked by required conditions
CI / integration test | determine publish changes (push) Blocked by required conditions
CI / integration test | registries (push) Blocked by required conditions
CI / integration test | uv publish (push) Blocked by required conditions
CI / integration test | uv_build (push) Blocked by required conditions
CI / check cache | ubuntu (push) Blocked by required conditions
CI / check cache | macos aarch64 (push) Blocked by required conditions
CI / check system | python on debian (push) Blocked by required conditions
CI / check system | python on fedora (push) Blocked by required conditions
CI / check system | python on ubuntu (push) Blocked by required conditions
CI / check system | python on rocky linux 10 (push) Blocked by required conditions
CI / check system | python on rocky linux 8 (push) Blocked by required conditions
CI / check system | python on rocky linux 9 (push) Blocked by required conditions
CI / check system | graalpy on ubuntu (push) Blocked by required conditions
CI / check system | pypy on ubuntu (push) Blocked by required conditions
CI / check system | pyston (push) Blocked by required conditions
CI / check system | python on macos aarch64 (push) Blocked by required conditions
CI / check system | homebrew python on macos aarch64 (push) Blocked by required conditions
CI / check system | x86-64 python on macos aarch64 (push) Blocked by required conditions
CI / check system | python on macos x86-64 (push) Blocked by required conditions
CI / check system | python3.10 on windows x86-64 (push) Blocked by required conditions
CI / check system | python3.10 on windows x86 (push) Blocked by required conditions
CI / check system | python3.13 on windows x86-64 (push) Blocked by required conditions
CI / check system | x86-64 python3.13 on windows aarch64 (push) Blocked by required conditions
CI / check system | aarch64 python3.13 on windows aarch64 (push) Blocked by required conditions
CI / check system | windows registry (push) Blocked by required conditions
CI / check system | python3.12 via chocolatey (push) Blocked by required conditions
CI / check system | python3.9 via pyenv (push) Blocked by required conditions
CI / check system | python3.13 (push) Blocked by required conditions
CI / check system | conda3.11 on macos aarch64 (push) Blocked by required conditions
CI / check system | conda3.8 on macos aarch64 (push) Blocked by required conditions
CI / check system | conda3.11 on linux x86-64 (push) Blocked by required conditions
CI / check system | conda3.8 on linux x86-64 (push) Blocked by required conditions
CI / check system | conda3.11 on windows x86-64 (push) Blocked by required conditions
CI / check system | conda3.8 on windows x86-64 (push) Blocked by required conditions
CI / check system | amazonlinux (push) Blocked by required conditions
CI / check system | embedded python3.10 on windows x86-64 (push) Blocked by required conditions
CI / benchmarks | walltime aarch64 linux (push) Blocked by required conditions
CI / benchmarks | instrumented (push) Blocked by required conditions
zizmor / Run zizmor (push) Waiting to run
Some checks are pending
CI / Determine changes (push) Waiting to run
CI / lint (push) Waiting to run
CI / cargo clippy | ubuntu (push) Blocked by required conditions
CI / cargo clippy | windows (push) Blocked by required conditions
CI / cargo publish dry-run (push) Blocked by required conditions
CI / cargo dev generate-all (push) Blocked by required conditions
CI / cargo shear (push) Waiting to run
CI / cargo test | ubuntu (push) Blocked by required conditions
CI / cargo test | macos (push) Blocked by required conditions
CI / cargo test | windows (push) Blocked by required conditions
CI / check windows trampoline | aarch64 (push) Blocked by required conditions
CI / check windows trampoline | i686 (push) Blocked by required conditions
CI / check windows trampoline | x86_64 (push) Blocked by required conditions
CI / test windows trampoline | aarch64 (push) Blocked by required conditions
CI / test windows trampoline | i686 (push) Blocked by required conditions
CI / test windows trampoline | x86_64 (push) Blocked by required conditions
CI / typos (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / build binary | linux libc (push) Blocked by required conditions
CI / build binary | linux aarch64 (push) Blocked by required conditions
CI / build binary | linux musl (push) Blocked by required conditions
CI / build binary | macos aarch64 (push) Blocked by required conditions
CI / build binary | macos x86_64 (push) Blocked by required conditions
CI / build binary | windows x86_64 (push) Blocked by required conditions
CI / build binary | windows aarch64 (push) Blocked by required conditions
CI / build binary | msrv (push) Blocked by required conditions
CI / build binary | freebsd (push) Blocked by required conditions
CI / ecosystem test | pydantic/pydantic-core (push) Blocked by required conditions
CI / ecosystem test | prefecthq/prefect (push) Blocked by required conditions
CI / ecosystem test | pallets/flask (push) Blocked by required conditions
CI / smoke test | linux (push) Blocked by required conditions
CI / smoke test | linux aarch64 (push) Blocked by required conditions
CI / check system | alpine (push) Blocked by required conditions
CI / smoke test | macos (push) Blocked by required conditions
CI / smoke test | windows x86_64 (push) Blocked by required conditions
CI / smoke test | windows aarch64 (push) Blocked by required conditions
CI / integration test | activate nushell venv (push) Blocked by required conditions
CI / integration test | conda on ubuntu (push) Blocked by required conditions
CI / integration test | deadsnakes python3.9 on ubuntu (push) Blocked by required conditions
CI / integration test | free-threaded on windows (push) Blocked by required conditions
CI / integration test | aarch64 windows implicit (push) Blocked by required conditions
CI / integration test | aarch64 windows explicit (push) Blocked by required conditions
CI / integration test | windows python install manager (push) Blocked by required conditions
CI / integration test | pypy on ubuntu (push) Blocked by required conditions
CI / integration test | pypy on windows (push) Blocked by required conditions
CI / integration test | graalpy on ubuntu (push) Blocked by required conditions
CI / integration test | graalpy on windows (push) Blocked by required conditions
CI / integration test | pyodide on ubuntu (push) Blocked by required conditions
CI / integration test | github actions (push) Blocked by required conditions
CI / integration test | free-threaded python on github actions (push) Blocked by required conditions
CI / integration test | pyenv on wsl x86-64 (push) Blocked by required conditions
CI / integration test | determine publish changes (push) Blocked by required conditions
CI / integration test | registries (push) Blocked by required conditions
CI / integration test | uv publish (push) Blocked by required conditions
CI / integration test | uv_build (push) Blocked by required conditions
CI / check cache | ubuntu (push) Blocked by required conditions
CI / check cache | macos aarch64 (push) Blocked by required conditions
CI / check system | python on debian (push) Blocked by required conditions
CI / check system | python on fedora (push) Blocked by required conditions
CI / check system | python on ubuntu (push) Blocked by required conditions
CI / check system | python on rocky linux 10 (push) Blocked by required conditions
CI / check system | python on rocky linux 8 (push) Blocked by required conditions
CI / check system | python on rocky linux 9 (push) Blocked by required conditions
CI / check system | graalpy on ubuntu (push) Blocked by required conditions
CI / check system | pypy on ubuntu (push) Blocked by required conditions
CI / check system | pyston (push) Blocked by required conditions
CI / check system | python on macos aarch64 (push) Blocked by required conditions
CI / check system | homebrew python on macos aarch64 (push) Blocked by required conditions
CI / check system | x86-64 python on macos aarch64 (push) Blocked by required conditions
CI / check system | python on macos x86-64 (push) Blocked by required conditions
CI / check system | python3.10 on windows x86-64 (push) Blocked by required conditions
CI / check system | python3.10 on windows x86 (push) Blocked by required conditions
CI / check system | python3.13 on windows x86-64 (push) Blocked by required conditions
CI / check system | x86-64 python3.13 on windows aarch64 (push) Blocked by required conditions
CI / check system | aarch64 python3.13 on windows aarch64 (push) Blocked by required conditions
CI / check system | windows registry (push) Blocked by required conditions
CI / check system | python3.12 via chocolatey (push) Blocked by required conditions
CI / check system | python3.9 via pyenv (push) Blocked by required conditions
CI / check system | python3.13 (push) Blocked by required conditions
CI / check system | conda3.11 on macos aarch64 (push) Blocked by required conditions
CI / check system | conda3.8 on macos aarch64 (push) Blocked by required conditions
CI / check system | conda3.11 on linux x86-64 (push) Blocked by required conditions
CI / check system | conda3.8 on linux x86-64 (push) Blocked by required conditions
CI / check system | conda3.11 on windows x86-64 (push) Blocked by required conditions
CI / check system | conda3.8 on windows x86-64 (push) Blocked by required conditions
CI / check system | amazonlinux (push) Blocked by required conditions
CI / check system | embedded python3.10 on windows x86-64 (push) Blocked by required conditions
CI / benchmarks | walltime aarch64 linux (push) Blocked by required conditions
CI / benchmarks | instrumented (push) Blocked by required conditions
zizmor / Run zizmor (push) Waiting to run
I consider this a bit too advanced to be in the top-level guides
This commit is contained in:
parent
666059bd88
commit
4b92f4fde4
7 changed files with 19 additions and 18 deletions
|
|
@ -8,9 +8,8 @@ description: Exporting a lockfile to different formats
|
|||
uv can export a lockfile to different formats for integration with other tools and workflows. The
|
||||
`uv export` command supports multiple output formats, each suited to different use cases.
|
||||
|
||||
For more details on lockfiles and how they're created, see the
|
||||
[project layout](../concepts/projects/layout.md) and
|
||||
[locking and syncing](../concepts/projects/sync.md) documentation.
|
||||
For more details on lockfiles and how they're created, see the [project layout](./layout.md) and
|
||||
[locking and syncing](./sync.md) documentation.
|
||||
|
||||
## Overview of export formats
|
||||
|
||||
|
|
@ -81,7 +80,7 @@ which is useful for security auditing, compliance, and supply chain transparency
|
|||
|
||||
!!! important
|
||||
|
||||
Support for exporting to CycloneDX is in [preview](../concepts/preview.md), and may change in any future release.
|
||||
Support for exporting to CycloneDX is in [preview](../preview.md), and may change in any future release.
|
||||
|
||||
### What is CycloneDX?
|
||||
|
||||
|
|
@ -111,8 +110,8 @@ following custom properties on components:
|
|||
|
||||
## Next steps
|
||||
|
||||
To learn more about lockfiles and exporting, see the
|
||||
[locking and syncing](../concepts/projects/sync.md) documentation and the
|
||||
[command reference](../reference/cli.md#uv-export).
|
||||
To learn more about lockfiles and exporting, see the [locking and syncing](./sync.md) documentation
|
||||
and the [command reference](../../reference/cli.md#uv-export).
|
||||
|
||||
Or, read on to learn how to [build and publish your project to a package index](./package.md).
|
||||
Or, read on to learn how to
|
||||
[build and publish your project to a package index](../../guides/package.md).
|
||||
|
|
@ -195,8 +195,8 @@ $ uv export --format pylock.toml
|
|||
$ uv export --format cyclonedx1.5
|
||||
```
|
||||
|
||||
See the [export guide](../../guides/export.md) for comprehensive documentation on all export formats
|
||||
and their use cases.
|
||||
See the [export guide](./export.md) for comprehensive documentation on all export formats and their
|
||||
use cases.
|
||||
|
||||
## Partial installations
|
||||
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ Because it is very common to run tools without installing them, a `uvx` alias is
|
|||
refer to `uvx` instead of `uv tool run`.
|
||||
|
||||
Tools can also be installed with `uv tool install`, in which case their executables are
|
||||
[available on the `PATH`](#the-path) — an isolated virtual environment is still used, but it is not
|
||||
removed when the command completes.
|
||||
[available on the `PATH`](#tool-executables) — an isolated virtual environment is still used, but it
|
||||
is not removed when the command completes.
|
||||
|
||||
## Execution vs installation
|
||||
|
||||
|
|
|
|||
|
|
@ -215,8 +215,8 @@ RUN uv run some_script.py
|
|||
|
||||
### Using installed tools
|
||||
|
||||
To use installed tools, ensure the [tool bin directory](../../concepts/tools.md#the-bin-directory)
|
||||
is on the path:
|
||||
To use installed tools, ensure the [tool bin directory](../../concepts/tools.md#tool-executables) is
|
||||
on the path:
|
||||
|
||||
```dockerfile title="Dockerfile"
|
||||
ENV PATH=/root/.local/bin:$PATH
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ Alternatively, `uv build <SRC>` will build the package in the specified director
|
|||
|
||||
The `uv version` command provides conveniences for updating the version of your package before you
|
||||
publish it.
|
||||
[See the project docs for reading your package's version](./projects.md#managing-version).
|
||||
[See the project docs for reading your package's version](./projects.md#viewing-your-version).
|
||||
|
||||
To update to an exact version, provide it as a positional argument:
|
||||
|
||||
|
|
|
|||
|
|
@ -272,4 +272,5 @@ To learn more about working on projects with uv, see the
|
|||
[projects concept](../concepts/projects/index.md) page and the
|
||||
[command reference](../reference/cli.md#uv).
|
||||
|
||||
Or, read on to learn how to [export a uv lockfile to different formats](./export.md).
|
||||
Or, read on to learn how to
|
||||
[export a uv lockfile to different formats](../concepts/projects/export.md).
|
||||
|
|
|
|||
|
|
@ -82,6 +82,7 @@ plugins:
|
|||
"configuration/files.md": "concepts/configuration-files.md"
|
||||
"configuration/indexes.md": "concepts/indexes.md"
|
||||
"configuration/environment.md": "reference/environment.md"
|
||||
"guides/export.md": "concepts/projects/export.md"
|
||||
- llmstxt:
|
||||
markdown_description: |
|
||||
You can use uv to install Python dependencies, run scripts, manage virtual environments,
|
||||
|
|
@ -101,7 +102,6 @@ plugins:
|
|||
- guides/scripts.md
|
||||
- guides/tools.md
|
||||
- guides/projects.md
|
||||
- guides/export.md
|
||||
- guides/package.md
|
||||
Integrations:
|
||||
- guides/integration/docker.md
|
||||
|
|
@ -124,6 +124,7 @@ plugins:
|
|||
- concepts/projects/sync.md
|
||||
- concepts/projects/config.md
|
||||
- concepts/projects/build.md
|
||||
- concepts/projects/export.md
|
||||
- concepts/projects/workspaces.md
|
||||
Features:
|
||||
- concepts/tools.md
|
||||
|
|
@ -178,7 +179,6 @@ nav:
|
|||
- Running scripts: guides/scripts.md
|
||||
- Using tools: guides/tools.md
|
||||
- Working on projects: guides/projects.md
|
||||
- Exporting lockfiles: guides/export.md
|
||||
- Publishing packages: guides/package.md
|
||||
- Migration:
|
||||
- guides/migration/index.md
|
||||
|
|
@ -208,6 +208,7 @@ nav:
|
|||
- Locking and syncing: concepts/projects/sync.md
|
||||
- Configuring projects: concepts/projects/config.md
|
||||
- Building distributions: concepts/projects/build.md
|
||||
- Exporting lockfiles: concepts/projects/export.md
|
||||
- Using workspaces: concepts/projects/workspaces.md
|
||||
- Tools: concepts/tools.md
|
||||
- Python versions: concepts/python-versions.md
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue