Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
ARG VARIANT=3.13-bookworm
FROM mcr.microsoft.com/devcontainers/python:1-${VARIANT}

RUN python -m pip install --no-cache-dir uv==0.10.7
41 changes: 41 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "Python Open Source Template",
"build": {
"dockerfile": "Dockerfile",
"args": {
"VARIANT": "3.13-bookworm"
}
},
"remoteUser": "vscode",
"updateRemoteUserUID": true,
"containerEnv": {
"UV_LINK_MODE": "copy"
},
"mounts": [
{
"source": "uv-cache-${devcontainerId}",
"target": "/home/vscode/.cache/uv",
"type": "volume"
}
],
"postCreateCommand": "uv sync --all-groups --locked && uv run pre-commit install --install-hooks",
"customizations": {
"vscode": {
"extensions": [
"astral-sh.ty",
"charliermarsh.ruff",
"ms-python.python",
"redhat.vscode-yaml"
],
"settings": {
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
},
"editor.formatOnSave": true,
"python.defaultInterpreterPath": "${containerWorkspaceFolder}/.venv/bin/python",
"python.testing.pytestEnabled": true
}
}
}
}
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ make verify # Checks, tests, package build, and strict documentation build
See [CONTRIBUTING.md](CONTRIBUTING.md) for contributor guidance and
[AGENTS.md](AGENTS.md) for agent instructions.

## Dev Container

Open the repository in a Dev Container to use the pinned Python and uv
environment. It installs all dependency groups and the configured Git hooks on
creation, while retaining the uv download cache between rebuilds.

## Documentation and Releases

Documentation lives in `docs/` and is built with Sphinx using the Palewire
Expand Down
Loading