Skip to content

uv.md

Latest commit

 

History

History
86 lines (78 loc) · 3.03 KB

uv.md

File metadata and controls

86 lines (78 loc) · 3.03 KB
Raw

uv Configurations

!!! TIP Official documentation for uv is available at https://docs.astral.sh/uv

Virtual Environment

Set the UV_PROJECT_ENVIRONMENT not to create a virtual environment in the project directory.

{
    "name": "uv",
    "dockerComposeFile": "../.devcontainer/docker-compose.yml",
    "service": "vscode",
    "runServices": [
        "vscode"
    ],
    "remoteUser": "vscode",
    "workspaceFolder": "/workspace",
    "mounts": [
        {
            "source": "cache-${devcontainerId}",
            "target": "/home/${remoteUser}/.cache",
            "type": "volume"
        },
        {
            "source": "${localEnv:HOME}/.ssh",
            "target": "/home/${remoteUser}/.ssh",
            "type": "bind"
        },
        {
            "source": "venv-${devcontainerId}",
            "target": "${containerWorkspaceFolder}/.venv",
            "type": "volume"
        }
    ],
    "features": {
        "ghcr.io/dhoeric/features/hadolint:1": {}
    },
    "customizations": {
        "vscode": {
            "extensions": [
                "astral-sh.ty",
                "charliermarsh.ruff",
                "exiasr.hadolint",
                "kevinrose.vsc-python-indent",
                "mosapride.zenkaku",
                "ms-azuretools.vscode-docker",
                "ms-python.python",
                "ms-toolsai.jupyter",
                "njpwerner.autodocstring",
                "quary.sqruff",
                "redhat.vscode-yaml",
                "shardulm94.trailing-spaces",
                "streetsidesoftware.code-spell-checker",
                "tamasfe.even-better-toml",
                "yzhang.markdown-all-in-one"
            ],
            "settings": {
                "python.defaultInterpreterPath": "./.venv/bin/python",
                "sqruff.executablePath": "${workspaceFolder}/.venv/bin/sqruff"
            }
        }
    },
    "containerEnv": {
        "DISPLAY": "dummy",
        "UV_PROJECT_ENVIRONMENT": "${containerWorkspaceFolder}/.venv"
    },
    "updateContentCommand": "sudo chown -R vscode /home/vscode/.cache /home/vscode/.ssh ${containerWorkspaceFolder}/.venv",
    "postCreateCommand": "uv sync --frozen",
    "postStartCommand": "uv run pre-commit install"
}

Key Configuration Details

Mounts Section:

  • The .venv directory is stored in a Docker named volume (venv-${devcontainerId}) for better performance and isolation
  • SSH keys from the host (${localEnv:HOME}/.ssh) are bind-mounted to enable git operations with SSH authentication

Environment Variables:

  • UV_PROJECT_ENVIRONMENT is set to ${containerWorkspaceFolder}/.venv to ensure uv uses the mounted volume

Update Content Command:

  • updateContentCommand sets proper ownership of .venv and .ssh directories to the vscode user after container updates

This configuration eliminates the need for volume definitions in docker-compose.yml, as volumes are managed directly through the devcontainer mounts section.