-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from a5chin/feature/actions
Fix GitHub Actions
- Loading branch information
Showing
9 changed files
with
207 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,9 +7,24 @@ on: | |
| branches: [ main ] | ||
|
|
||
| jobs: | ||
| docker: | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Lint Dockerfile | ||
| uses: hadolint/[email protected] | ||
| with: | ||
| dockerfile: Dockerfile | ||
|
|
||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| needs: lint | ||
| if: ${{ success() }} | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # VSCode Dev Container: Python Development with Rye, uv, and Ruff | ||
|
|
||
| <div align="center"> | ||
|
|
||
| [](https://github.com/astral-sh/rye) | ||
| [](https://github.com/astral-sh/uv) | ||
| [](https://github.com/astral-sh/ruff) | ||
|
|
||
| [](https://github.com/a5chin/python-rye) | ||
|
|
||
| [](https://github.com/a5chin/python-rye/actions/workflows/ruff.yml) | ||
| [](https://github.com/a5chin/python-rye/actions/workflows/test.yml) | ||
| [](https://github.com/a5chin/python-rye/actions/workflows/docker.yml) | ||
|
|
||
| </div> | ||
|
|
||
| ## Overview | ||
| This repository contains configurations to set up a Python development environment using VSCode's Dev Container feature. | ||
| The environment includes Rye, uv, and Ruff. | ||
|
|
||
| ## Contents | ||
| The following are the features. | ||
|
|
||
| ### 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-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` | ||
| - Rye | ||
| - `rye config --set-bool behavior.global-python=true` | ||
| - `rye config --set-bool behavior.use-uv=true` | ||
| - 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 | ||
| # Linter | ||
| ruff check . --fix | ||
|
|
||
| # Formatter | ||
| ruff format . | ||
| ``` | ||
|
|
||
| ### Install | ||
| Only sync based on the production lockfile (`requirements.lock`) instead of the development lockfile (`requirements-dev.lock`). | ||
|
|
||
| ```sh | ||
| # Install also include develop dependencies | ||
| rye sync | ||
|
|
||
| # If you do not want dev dependencies to be installed | ||
| rye sync --no-dev | ||
| ``` | ||
|
|
||
| ## Appendix | ||
| ### The structure of this repository | ||
| ``` | ||
| . | ||
| ├── .devcontainer | ||
| │ ├── devcontainer.json | ||
| │ └── Dockerfile | ||
| ├── Dockerfile | ||
| ├── .github | ||
| │ └── workflows | ||
| │ ├── docker.yml | ||
| │ ├── ruff.yml | ||
| │ └── pytest.yml | ||
| ├── .gitignore | ||
| ├── LICENSE | ||
| ├── .pre-commit-config.yaml | ||
| ├── pyproject.toml | ||
| ├── .python-version | ||
| ├── README.md | ||
| ├── requirements-dev.lock | ||
| ├── requirements.lock | ||
| ├── ruff.toml | ||
| └── .vscode | ||
| └── settings.json | ||
| ``` |