Skip to content

Python UV.md

Latest commit

 

History

History
271 lines (218 loc) · 5.8 KB

Python UV.md

File metadata and controls

271 lines (218 loc) · 5.8 KB

UV

UV is Python package and project manager (virtual environment), written in Rust.

Self claimed: A single tool to replace pip, pip-tools, pipx, poetry, pyenv, twine, virtualenv, and more. 10-100x faster than pip
Read more at:
https://docs.astral.sh/uv/

From

This CheatSheet is close to
https://gist.github.com/rollingmountains

Project Handling

Initialize New Project

uv init myproject
cd myproject

Initialize in Current Directory

uv init

Initialize with Specific Python Version

uv init --python 3.11

Virtual Environment Management

Create Virtual Environment

uv venv                    # Create .venv in current directory
uv venv myenv             # Create named environment
uv venv --python 3.11     # Specify Python version

List Virtual Environments

ls -la                     # Show .venv in current directory
find ~ -name ".venv" -type d 2>/dev/null  # Find all .venv directories
uv venv list              # List UV managed environments (if available)

Find Virtual Environment Location

echo $VIRTUAL_ENV         # Show active venv path
which python              # Show active Python executable path
python -c "import sys; print(sys.prefix)"  # Show Python environment prefix
pwd                       # Current directory (where .venv usually is)

Check Virtual Environment Status

echo $VIRTUAL_ENV         # Shows path if venv is active
ps1                       # Check if prompt shows venv name
python --version          # Check Python version in current env

Activate Virtual Environment

source .venv/bin/activate

Deactivate Virtual Environment

deactivate               # Exit virtual environment

Create and Use Environment in One Step

uv run python script.py   # Auto-creates venv if needed

Package Management

Install Packages

uv add requests            # Add package to project
uv add "django>=4.0"      # Add with version constraint
uv add --dev pytest       # Add as development dependency
uv add --optional test pytest  # Add to optional group

Remove Packages

uv remove requests         # Remove package
uv remove --dev pytest    # Remove dev dependency

Install from Requirements

uv pip install -r requirements.txt
uv sync                    # Install all project dependencies

Upgrade Packages

uv lock --upgrade          # Update lock file
uv sync                    # Sync to updated versions

Environment Checks & Info

Check Virtual Environment Status

which python              # Shows active Python path
echo $VIRTUAL_ENV         # Shows active venv path
uv python list           # List available Python versions

Environment Information

uv info                   # Show UV configuration
uv python find 3.11      # Find specific Python version
uv tree                  # Show dependency tree

List Installed Packages

uv pip list               # List packages in current env
uv pip show package_name  # Show package details

Check Project Status

uv status                 # Show project sync status  
uv check                  # Validate project dependencies

Python Version Management

Install Python Versions

uv python install 3.11   # Install Python 3.11
uv python install 3.12   # Install Python 3.12
uv python list           # List installed versions

Set Project Python Version

uv python pin 3.11       # Pin project to Python 3.11

Running Code

Run Python Scripts

uv run python script.py   # Run with project venv
uv run --python 3.11 script.py  # Run with specific version

Run Commands in Environment

uv run pytest            # Run pytest in project env
uv run django-admin startproject mysite

Lock File Management

Generate Lock File

uv lock                  # Generate uv.lock
uv lock --upgrade        # Upgrade all dependencies

Export Lock File

uv export > requirements.txt        # Export to requirements.txt
uv export --dev > requirements-dev.txt  # Include dev dependencies

Environment Cleanup

Remove Virtual Environment

rm -rf .venv             # Delete .venv directory

Clean UV Cache

uv cache clean           # Clean package cache
uv cache dir             # Show cache directory

Useful Environment Variables

Set UV Configuration

export UV_CACHE_DIR=~/.cache/uv     # Set cache directory
export UV_TOOL_DIR=~/.local/share/uv/tools  # Set tools directory
export UV_PYTHON_INSTALL_DIR=~/.local/share/uv/python  # Python install dir

Quick Project Setup Workflow

New Project from Scratch

mkdir myproject && cd myproject
uv init
uv add requests flask
source .venv/bin/activate
uv run python -c "import requests; print('Setup complete!')"

Existing Project

cd existing_project
uv init
uv add package1 package2
uv sync
source .venv/bin/activate

Troubleshooting

Common Issues

# If UV not found after installation
source ~/.bashrc         # or ~/.zshrc

# Check if venv is activated
echo $VIRTUAL_ENV

# Reinstall UV
curl -LsSf https://astral.sh/uv/install.sh | sh

# Reset project environment
rm -rf .venv uv.lock
uv sync

Debug Commands

uv --verbose run python script.py    # Verbose output
uv doctor                            # System diagnostics (if available)

Installation

Method 1: Official Installer (Recommended)

curl -LsSf https://astral.sh/uv/install.sh | sh

Method 2: Homebrew

brew install uv

Method 3: pipx

pipx install uv

Verify Installation

uv --version

Update UV

uv self update