Skip to content

Commit

Permalink
πŸ”„ synced file(s) with klaasnicolaas/github-config (#235)
Browse files Browse the repository at this point in the history
* πŸ”„ created local '.devcontainer/' from remote 'python_package/.devcontainer'

* πŸ”„ synced local '.gitignore' with remote 'python_package/.gitignore'

* Add dev container shield label
  • Loading branch information
klaasnicolaas committed Jul 6, 2023
1 parent 5e26a19 commit 6387d24
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 8 deletions.
65 changes: 65 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"name": "${containerWorkspaceFolderBasename}",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"customizations": {
"codespaces": {
"openFiles": ["README.md"]
},
"vscode": {
"extensions": [
"GitHub.copilot",
"GitHub.vscode-github-actions",
"GitHub.vscode-pull-request-github",
"Tyriar.sort-lines",
"charliermarsh.ruff",
"esbenp.prettier-vscode",
"mhutchie.git-graph",
"ms-python.python",
"oderwat.indent-rainbow",
"redhat.vscode-yaml",
"ryanluker.vscode-coverage-gutters"
],
"settings": {
"[python]": {
"editor.codeActionsOnSave": {
"source.fixAll": true,
"source.organizeImports": true
}
},
"coverage-gutters.customizable.context-menu": true,
"coverage-gutters.customizable.status-bar-toggler-watchCoverageAndVisibleEditors-enabled": true,
"coverage-gutters.showGutterCoverage": false,
"coverage-gutters.showLineCoverage": true,
"coverage-gutters.xmlname": "coverage.xml",
"python.analysis.extraPaths": ["${workspaceFolder}/src"],
"python.defaultInterpreterPath": ".venv/bin/python",
"python.formatting.provider": "black",
"python.linting.enabled": true,
"python.linting.mypyEnabled": true,
"python.linting.pylintEnabled": true,
"python.testing.cwd": "${workspaceFolder}",
"python.testing.pytestArgs": ["--cov-report=xml"],
"python.testing.pytestEnabled": true,
"ruff.importStrategy": "fromEnvironment",
"ruff.interpreter": [".venv/bin/python"],
"terminal.integrated.defaultProfile.linux": "zsh"
}
}
},
"features": {
"ghcr.io/devcontainers/features/git:1": {},
"ghcr.io/devcontainers/features/github-cli:1": {},
"ghcr.io/devcontainers-contrib/features/poetry:2": {},
"ghcr.io/devcontainers-contrib/features/pre-commit:2": {},
"ghcr.io/devcontainers/features/common-utils:2": {
"installOhMyZsh": true
},
"ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
"plugins": "git zsh-autosuggestions zsh-syntax-highlighting zsh-completions",
"omzPlugins": "https://github.com/zsh-users/zsh-autosuggestions.git https://github.com/zsh-users/zsh-syntax-highlighting.git https://github.com/zsh-users/zsh-completions.git"
},
"ghcr.io/devcontainers/features/python:1": {
"installTools": false
}
}
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,4 @@ venv.bak/
.pyre/

setup.py
.python-version
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
[![GitHub Activity][commits-shield]][commits-url]
[![PyPi Downloads][downloads-shield]][downloads-url]
[![GitHub Last Commit][last-commit-shield]][commits-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Open in Dev Containers][devcontainer-shield]][devcontainer]

[![Code Quality][code-quality-shield]][code-quality]
[![Build Status][build-shield]][build-url]
Expand Down Expand Up @@ -125,8 +124,14 @@ Thank you for being involved! :heart_eyes:

## Setting up development environment

This Python project is fully managed using the [Poetry][poetry] dependency
manager.
The simplest way to begin is by utilizing the [Dev Container][devcontainer]
feature of Visual Studio Code or by opening a CodeSpace directly on GitHub.
By clicking the button below you immediately start a Dev Container in Visual Studio Code.

[![Open in Dev Containers][devcontainer-shield]][devcontainer]

This Python project relies on [Poetry][poetry] as its dependency manager,
providing comprehensive management and control over project dependencies.

You need at least:

Expand Down Expand Up @@ -207,10 +212,10 @@ SOFTWARE.
[commits-url]: https://github.com/klaasnicolaas/python-liege/commits/main
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-liege/branch/main/graph/badge.svg?token=jTIsaqV5x0
[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-liege
[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-liege
[downloads-shield]: https://img.shields.io/pypi/dm/liege
[downloads-url]: https://pypistats.org/packages/liege
[issues-shield]: https://img.shields.io/github/issues/klaasnicolaas/python-liege.svg
[issues-url]: https://github.com/klaasnicolaas/python-liege/issues
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-liege.svg
[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-liege.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
Expand All @@ -223,8 +228,6 @@ SOFTWARE.
[typing-url]: https://github.com/klaasnicolaas/python-liege/actions/workflows/typing.yaml
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-liege.svg
[releases]: https://github.com/klaasnicolaas/python-liege/releases
[stars-shield]: https://img.shields.io/github/stars/klaasnicolaas/python-liege.svg
[stars-url]: https://github.com/klaasnicolaas/python-liege/stargazers

[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
Expand Down

0 comments on commit 6387d24

Please sign in to comment.