uv learning notes

Table of contents

features

python versions

installing and managing python:

• uv python install: install python version
• uv python list: view all available python versions
• uv python find: find an installed python version
• uv python pin: pin the current project to use a specific python version
• uv python uninstall:

scripts

executing standalone python scripts, like example.py:

• uv run: run a script
• uv add --script: add a dependency to a script
• uv remove --script: remove a dependency from a script

projects

• uv init: create a new python project
• uv add: add a dependency to the project
• uv remove: remove a dependency from the project
• uv sync: sync the project’s dependencies with the environment
• uv lock: create a lockfile
• uv run: run a command in the project environ
• uv tree: view dependency tree for the project
• uv build: build the project into distribution archives
• uv publish: publish the project

tools

• uv tool run: run a tool in a temporary environment
• uv tool install: install a tool use-wide
• uv tool uninstall: uninstall a tool
• uv tool list: list installed tools
• uv tool update-shell: update the shell to include tool executables.

guides

scripts

without dependency:

import sys

print("".join(sys.argv[1:]))

uv run example.py test

# not depend on the project
uv run --no-project example.py

with dependency:

uv run --with rich example.py

creating a python script

uv init --script example.py --python 3.12

declare script dependencies

uv add --script example.py 'requests<3' 'rich'

alternative package indexes

uv add --index "https" --script example.py 'rich'

locking dependency

uv lock --script example.py