Skip to content

Commit

Permalink
added devcontainer
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisTimperley committed Jun 21, 2024
1 parent 44de65e commit 5249dde
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
10 changes: 10 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
"name": "Python 3",
"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
"features": {
"ghcr.io/devcontainers-contrib/features/poetry:2": {}
},
"postCreateCommand": "make install"
}
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ This repository provides a template for Python 3.12 projects based on [Poetry](h
* [pytest](https://docs.pytest.org/en/8.2.x) is used for writing tests
* [ruff](https://docs.astral.sh/ruff) is used for linting and formatting

The file also provides a [GitHub Actions](https://docs.github.com/en/actions) workflow that automatically builds, lints, type checks, and tests the project on every commit, pull request, and direct invocation of the workflow.
The repository also provides a [GitHub Actions](https://docs.github.com/en/actions) workflow that automatically builds, lints, type checks, and tests the project on every commit, pull request, and direct invocation of the workflow.

Finally, this repository provides a [DevContainer](https://containers.dev) to allow you to get started with development without installing anything to your machine (other than Docker and VSCode).
To open this project up inside a DevContainer, bring up the command palette in VSCode (CTRL-Shift-P or Command-Shift-P) and select "rebuild and reopen project in DevContainer".

## Usage

Expand Down

0 comments on commit 5249dde

Please sign in to comment.