mirror of https://github.com/astral-sh/uv
Move the "Export" guide to the projects concept section (#16835)
I consider this a bit too advanced to be in the top-level guides
This commit is contained in:
parent
666059bd88
commit
4b92f4fde4
|
|
@ -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 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.
|
`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
|
For more details on lockfiles and how they're created, see the [project layout](./layout.md) and
|
||||||
[project layout](../concepts/projects/layout.md) and
|
[locking and syncing](./sync.md) documentation.
|
||||||
[locking and syncing](../concepts/projects/sync.md) documentation.
|
|
||||||
|
|
||||||
## Overview of export formats
|
## Overview of export formats
|
||||||
|
|
||||||
|
|
@ -81,7 +80,7 @@ which is useful for security auditing, compliance, and supply chain transparency
|
||||||
|
|
||||||
!!! important
|
!!! 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?
|
### What is CycloneDX?
|
||||||
|
|
||||||
|
|
@ -111,8 +110,8 @@ following custom properties on components:
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
|
|
||||||
To learn more about lockfiles and exporting, see the
|
To learn more about lockfiles and exporting, see the [locking and syncing](./sync.md) documentation
|
||||||
[locking and syncing](../concepts/projects/sync.md) documentation and the
|
and the [command reference](../../reference/cli.md#uv-export).
|
||||||
[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
|
$ uv export --format cyclonedx1.5
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [export guide](../../guides/export.md) for comprehensive documentation on all export formats
|
See the [export guide](./export.md) for comprehensive documentation on all export formats and their
|
||||||
and their use cases.
|
use cases.
|
||||||
|
|
||||||
## Partial installations
|
## 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`.
|
refer to `uvx` instead of `uv tool run`.
|
||||||
|
|
||||||
Tools can also be installed with `uv tool install`, in which case their executables are
|
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
|
[available on the `PATH`](#tool-executables) — an isolated virtual environment is still used, but it
|
||||||
removed when the command completes.
|
is not removed when the command completes.
|
||||||
|
|
||||||
## Execution vs installation
|
## Execution vs installation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -215,8 +215,8 @@ RUN uv run some_script.py
|
||||||
|
|
||||||
### Using installed tools
|
### Using installed tools
|
||||||
|
|
||||||
To use installed tools, ensure the [tool bin directory](../../concepts/tools.md#the-bin-directory)
|
To use installed tools, ensure the [tool bin directory](../../concepts/tools.md#tool-executables) is
|
||||||
is on the path:
|
on the path:
|
||||||
|
|
||||||
```dockerfile title="Dockerfile"
|
```dockerfile title="Dockerfile"
|
||||||
ENV PATH=/root/.local/bin:$PATH
|
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
|
The `uv version` command provides conveniences for updating the version of your package before you
|
||||||
publish it.
|
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:
|
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
|
[projects concept](../concepts/projects/index.md) page and the
|
||||||
[command reference](../reference/cli.md#uv).
|
[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/files.md": "concepts/configuration-files.md"
|
||||||
"configuration/indexes.md": "concepts/indexes.md"
|
"configuration/indexes.md": "concepts/indexes.md"
|
||||||
"configuration/environment.md": "reference/environment.md"
|
"configuration/environment.md": "reference/environment.md"
|
||||||
|
"guides/export.md": "concepts/projects/export.md"
|
||||||
- llmstxt:
|
- llmstxt:
|
||||||
markdown_description: |
|
markdown_description: |
|
||||||
You can use uv to install Python dependencies, run scripts, manage virtual environments,
|
You can use uv to install Python dependencies, run scripts, manage virtual environments,
|
||||||
|
|
@ -101,7 +102,6 @@ plugins:
|
||||||
- guides/scripts.md
|
- guides/scripts.md
|
||||||
- guides/tools.md
|
- guides/tools.md
|
||||||
- guides/projects.md
|
- guides/projects.md
|
||||||
- guides/export.md
|
|
||||||
- guides/package.md
|
- guides/package.md
|
||||||
Integrations:
|
Integrations:
|
||||||
- guides/integration/docker.md
|
- guides/integration/docker.md
|
||||||
|
|
@ -124,6 +124,7 @@ plugins:
|
||||||
- concepts/projects/sync.md
|
- concepts/projects/sync.md
|
||||||
- concepts/projects/config.md
|
- concepts/projects/config.md
|
||||||
- concepts/projects/build.md
|
- concepts/projects/build.md
|
||||||
|
- concepts/projects/export.md
|
||||||
- concepts/projects/workspaces.md
|
- concepts/projects/workspaces.md
|
||||||
Features:
|
Features:
|
||||||
- concepts/tools.md
|
- concepts/tools.md
|
||||||
|
|
@ -178,7 +179,6 @@ nav:
|
||||||
- Running scripts: guides/scripts.md
|
- Running scripts: guides/scripts.md
|
||||||
- Using tools: guides/tools.md
|
- Using tools: guides/tools.md
|
||||||
- Working on projects: guides/projects.md
|
- Working on projects: guides/projects.md
|
||||||
- Exporting lockfiles: guides/export.md
|
|
||||||
- Publishing packages: guides/package.md
|
- Publishing packages: guides/package.md
|
||||||
- Migration:
|
- Migration:
|
||||||
- guides/migration/index.md
|
- guides/migration/index.md
|
||||||
|
|
@ -208,6 +208,7 @@ nav:
|
||||||
- Locking and syncing: concepts/projects/sync.md
|
- Locking and syncing: concepts/projects/sync.md
|
||||||
- Configuring projects: concepts/projects/config.md
|
- Configuring projects: concepts/projects/config.md
|
||||||
- Building distributions: concepts/projects/build.md
|
- Building distributions: concepts/projects/build.md
|
||||||
|
- Exporting lockfiles: concepts/projects/export.md
|
||||||
- Using workspaces: concepts/projects/workspaces.md
|
- Using workspaces: concepts/projects/workspaces.md
|
||||||
- Tools: concepts/tools.md
|
- Tools: concepts/tools.md
|
||||||
- Python versions: concepts/python-versions.md
|
- Python versions: concepts/python-versions.md
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue