Skip to content

README.md

Latest commit

 

History

History
42 lines (29 loc) · 1.17 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.17 KB

Development Container

This is Devcontainer configuration to provide a consistent development environment for all contributors.

Features

  • Pre-configured Python environment
  • Automatic installation of pre-commit hooks
  • Ruff linter ready to check your code
  • Oh My Zsh with plugins:
  • zsh-autosuggestions
  • zsh-syntax-highlighting

Usage

  1. Install Docker and Visual Studio Code

  2. Install the Remote - Containers extension in VS Code

    • Do CTRL+P, paste this command and press Enter

      ext install ms-vscode-remote.remote-containers

  3. Open this repository in VS Code

  4. When prompted, click "Reopen in Container"

  5. Wait for the environment to build and initialize

After setup:

  • pre-commit hooks are installed
  • ruff and other tools are available
  • The shell uses Zsh by default

Tips

To manually run checks on all files:

pre-commit run --all-files

For further information here's Microsoft tutorial about devcontainers.