Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add initial devcontainer.json config #36

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prometheas
Copy link

What

  • Adds a devcontainer.json config file, enabling containerized development environment using Python 3.9 (the same version of Python used in the root Dockerfile of the repo), to create a development environment consistent with the deployment environment.

Screenshot

N/A

Fixes bug(s)

N/A

Part of

N/A

Using the version of Python 3 matching the version used in the root
`Dockerfile` of the repo (3.9).  The container also includes the
`docker-outside-of-docker` dev container feature.
@alexgarel
Copy link
Member

Hi @prometheas, can you explain it a bit to me ? Isn't the docker-compose sufficient ?

If it adds some new capabilities, could you add a small explanation in the README ?

@alexgarel
Copy link
Member

And thanks a lot for this first PR @prometheas 🎉

{
"name": "Python 3",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/python:0-3.9",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not use the Dockerfile instead ?

@prometheas
Copy link
Author

Hi @prometheas, can you explain it a bit to me ? Isn't the docker-compose sufficient ?

If it adds some new capabilities, could you add a small explanation in the README ?

Hi, @alexgarel 👋 this PR adds a Dev Container file to the project, allowing developers to create a uniform development environment. This is notable different to the container used by docker-compose, which offers reliable parity for runtime only (which is not used to, say, run the make scripts or any of the development-level scripts and automations.

Consistent versions of Python and any number of supporting cli tools become trivial, allowing newcomers to get started in minutes, rather than hours or days. Even allows for development directly in the web browser at GitHub Codespaces, or vscode.com.

Good point about updating info in the README, though. Will get on that today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog (ready for dev)
Development

Successfully merging this pull request may close these issues.

3 participants