https://github.com/a5chin/python-poetry

This repository contains configurations to set up a Python development environment using VSCode's Dev Container feature. The environment includes Poetry, pyenv, and Ruff.
https://github.com/a5chin/python-poetry

devcontainer docker dockerfile poetry precommit pyenv python python3 ruff

Last synced: 27 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/a5chin/python-poetry
• Owner: a5chin
• License: mit
• Created: 2024-04-29T04:31:21.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T10:26:32.000Z (over 1 year ago)
• Last Synced: 2024-08-09T11:56:47.216Z (over 1 year ago)
• Topics: devcontainer, docker, dockerfile, poetry, precommit, pyenv, python, python3, ruff
• Language: Dockerfile
• Homepage:
• Size: 212 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# VSCode Dev Container: Python Development with Poetry, pyenv, and Ruff



[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)

[![pyenv](https://img.shields.io/badge/-pyenv-blue.svg)]()

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Versions](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20-blue.svg)](https://github.com/a5chin/python-poetry)

[![Ruff](https://github.com/a5chin/python-poetry/actions/workflows/ruff.yml/badge.svg)](https://github.com/a5chin/python-poetry/actions/workflows/ruff.yml)

[![test](https://github.com/a5chin/python-poetry/actions/workflows/test.yml/badge.svg)](https://github.com/a5chin/python-poetry/actions/workflows/test.yml)

[![Docker](https://github.com/a5chin/python-poetry/actions/workflows/docker.yml/badge.svg)](https://github.com/a5chin/python-poetry/actions/workflows/docker.yml)



## Overview

This repository contains configurations to set up a Python development environment using VSCode's Dev Container feature.

The environment includes Poetry, pyenv, and Ruff.

## Contents

The following are the features.

### Branches

- [main](https://github.com/a5chin/python-poetry/tree/main)

- [jupyter](https://github.com/a5chin/python-poetry/tree/jupyter)

### Dev Container

- `devcontainer.json`

  - settings

    - formatOnSave by Ruff

  - features

    - pre-commit

  - extentions

    - [charliermarsh.ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)

    - [codezombiech.gitignore](https://marketplace.visualstudio.com/items?itemName=codezombiech.gitignore)

    - [eamodio.gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)

    - [kevinrose.vsc-python-indent](https://marketplace.visualstudio.com/items?itemName=kevinrose.vsc-python-indent)

    - [mosapride.zenkaku](https://marketplace.visualstudio.com/items?itemName=mosapride.zenkaku)

    - [ms-azuretools.vscode-docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker)

    - [ms-python.python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)

    - [njpwerner.autodocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)

    - [oderwat.indent-rainbow](https://marketplace.visualstudio.com/items?itemName=oderwat.indent-rainbow)

    - [pkief.material-icon-theme](https://marketplace.visualstudio.com/items?itemName=pkief.material-icon-theme)

    - [shardulm94.trailing-spaces](https://marketplace.visualstudio.com/items?itemName=shardulm94.trailing-spaces)

    - [usernamehw.errorlens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens)

    - [yzhang.markdown-all-in-one](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)

- `Dockerfile`

  - Poetry

    - `poetry config virtualenvs.create false`

  - Only Dev dependencies

    - `pre-commit`

    - `pytest`

    - `ruff`

### GitHub Actions

- `docker.yml`

  - Workflow to check if you can build with Docker

- `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](https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules) to set it to ignore conflicts such as the following:

```toml

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.

```sh

# Python Formatter

ruff format .

# Python Linter

ruff check . --fix

# Docker Linter

hodolint Dockerfile

```

### Install

Only install based on the production group instead of the development group (`tool.poetry.group.dev.dependencies`) in `pyproject.toml`.

```sh

# Install also include develop dependencies

poetry install

# If you do not want dev dependencies to be installed

poetry install --no-dev

```

## Appendix

### The structure of this repository

```

.

├── .devcontainer

│   ├── devcontainer.json

│   └── Dockerfile

├── Dockerfile

├── .github

│   └── workflows

│       ├── docker.yml

│       ├── ruff.yml

│       └── pytest.yml

├── .gitignore

├── LICENSE

├── poetry.lock

├── poetry.toml

├── .pre-commit-config.yaml

├── pyproject.toml

├── .python-version

├── README.md

├── ruff.toml

└── .vscode

    ├── extensions.json

    └── settings.json

```