diff --git a/pages/common/uv-add.md b/pages/common/uv-add.md new file mode 100644 index 00000000000000..bd82bd004e53bf --- /dev/null +++ b/pages/common/uv-add.md @@ -0,0 +1,37 @@ +# uv add + +> Add package dependencies to the `pyproject.toml` file. +> Packages are specified according to . +> More information: . + +- Add the latest version of a package: + +`uv add {{package}}` + +- Add multiple packages: + +`uv add {{package1 package2 ...}}` + +- Add a package with a version requirement: + +`uv add {{package>=1.2.3}}` + +- Add packages to an optional dependency group, which will be included when published: + +`uv add --optional {{optional}} {{package1 package2 ...}}` + +- Add packages to a local group, which will not be included when published: + +`uv add --group {{group}} {{package1 package2 ...}}` + +- Add packages to the dev group, shorthand for `--group dev`: + +`uv add --dev {{package1 package2 ...}}` + +- Add package as editable: + +`uv add --editable {{path/to/package/}}` + +- Enable an extra when installing package, may be provided multiple times: + +`uv add {{package}} --extra {{extra_feature}}` diff --git a/pages/common/uv-tree.md b/pages/common/uv-tree.md new file mode 100644 index 00000000000000..8a5d97612a430e --- /dev/null +++ b/pages/common/uv-tree.md @@ -0,0 +1,28 @@ +# uv tree + +> Display project dependencies in a tree format. +> More information: . + +- Show dependency tree for current environment: + +`uv tree` + +- Show dependency tree for all environments: + +`uv tree --universal` + +- Show dependency tree up to a certain depth: + +`uv tree {{-d|--depth}} {{n}}` + +- Show the latest available version for all outdated packages: + +`uv tree --outdated` + +- Exclude dependencies from the dev group: + +`uv tree --no-dev` + +- Show the inverted tree, so children are dependents instead of dependencies: + +`uv tree --invert` diff --git a/pages/common/uv.md b/pages/common/uv.md index b738b2d4505ff7..5963d9afbdb946 100644 --- a/pages/common/uv.md +++ b/pages/common/uv.md @@ -8,15 +8,15 @@ `uv init` -- Create a new Python project in a directory with the given name: +- Create a new Python project at the specified path: -`uv init {{project_name}}` +`uv init {{path}}` -- Add a new package to the project: +- Add a new dependency to the project: `uv add {{package}}` -- Remove a package from the project: +- Remove a dependency from the project: `uv remove {{package}}`