README.md

VSCode Dev Container: Python Development with uv and Ruff

Overview

This repository contains configurations to set up a Python development environment using VSCode's Dev Container feature. The environment includes uv, and Ruff.

If the Ruff format does not work, try reloading the VS Code window. Specifically, you can solve this problem by following the steps below.

1. Type ⌘+⇧+P to open the command palette
2. Type Developer: Reload Window in the command palette to reload the window

Contents

• VSCode Dev Container: Python Development with uv and Ruff
  • Overview
    • Contents
  • Branches
  • Settings
  • Dev Container
  • GitHub Actions
  • Ruff
  • pre-commit
  • Appendix
    • Install libraries
    • The structure of this repository

Branches

• main
• jupyter
• rye（Archived）

Settings

• files.insertFinalNewline
• files.trimTrailingWhitespace
• editor.formatOnSave
  • dockercompose
  • dockerfile
  • github-actions-workflow
  • json, jsonc
  • python
  • toml
  • yaml

Dev Container

• devcontainer.json
  • features
    • hadolint
  • extentions
    • charliermarsh.ruff
    • codezombiech.gitignore
    • eamodio.gitlens
    • kevinrose.vsc-python-indent
    • mosapride.zenkaku
    • ms-azuretools.vscode-docker
    • ms-python.python
    • njpwerner.autodocstring
    • oderwat.indent-rainbow
    • pkief.material-icon-theme
    • redhat.vscode-yaml
    • shardulm94.trailing-spaces
    • tamasfe.even-better-toml
    • usernamehw.errorlens
    • yzhang.markdown-all-in-one
• Dockerfile
  • Only Dev dependencies
    • pre-commit
    • pyright
    • pytest
    • ruff
• buildWithRust.Dockerfile
  • Use the Rust compiler when you need it!
  • Fix dockerfile in .devcontainer/devcontainer.json

GitHub Actions

• docker.yml
  • Workflow to check if you can build with Docker
• pyright.yml
  • Workflow to check type
• test.yml
  • Workflow to check if all the described tests can be passed with pytest
• ruff.yml
  • Workflow to check if you can go through Formatter and Linter with Ruff

Ruff

Ruff can be used to replace Flake8, Black, isort, pydocstyle, pyupgrade, autoflake, etc., and yet run tens to hundreds of times faster than the individual tools.

To change the configuration, it is necessary to rewrite ruff.toml, and it is recommended to set it to ignore conflicts such as the following:

ignore = [
    "COM812", "COM819",
    "D100", "D203", "D213", "D300",
    "E111", "E114", "E117",
    "ISC001", "ISC002",
    "Q000", "Q001", "Q002", "Q003",
    "W191",
]

pre-commit

The .pre-commit-config.yaml file can contain scripts to be executed before commit.

# Python Formatter
uv run ruff format .

# Python Linter
uv run ruff check . --fix

# Docker Linter
hodolint Dockerfile

Appendix

Install libraries

# Install also include develop dependencies
uv sync

# If you do not want dev dependencies to be installed
uv sync --no-dev

# Use the add command to add dependencies to your project
uv add {libraries}

The structure of this repository

.
├── .devcontainer
│   ├── buildWithRust.Dockerfile
│   ├── devcontainer.json
│   └── Dockerfile
├── Dockerfile
├── .github
│   ├── actions
│   │   └── setup-python-with-uv
│   │       └── action.yml
│   ├── dependabot.yml
│   └── workflows
│       ├── docker.yml
│       ├── pyright.yml
│       ├── ruff.yml
│       └── test.yml
├── .dockergitignore
├── .gitignore
├── LICENSE
├── .pre-commit-config.yaml
├── pyproject.toml
├── pyrightconfig.json
├── .python-version
├── README.md
├── ruff.toml
├── uv.lock
└── .vscode
    ├── extensions.json
    └── settings.json