feat: Add devcontainer config

[matthewfeickert]

Description

• Add devcontainer config using the pyhf Dockerfile.
  • c.f. https://containers.dev/
  • Motivated by @crazy4pi314's SciPy 2023 lightning talk.

@crazy4pi314, @guenp, and @ltalirz also gave the SciPy 2023 tutorial Meet your coding best friend: VS Code💖 - A hands-on tutorial on how to get the most out of the world’s most popular Python editor which covers dev containers in it as well: https://github.com/crazy4pi314/scipy-vscode-tutorial

Checklist Before Requesting Reviewer

• Tests are passing
• "WIP" removed from the title of the pull request
• Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

• Summarize commit messages into a comprehensive review of the PR

* Add devcontainer config using the pyhf Dockerfile.
   - c.f. https://containers.dev/
   - Motivated by Sarah Kaiser's SciPy 2023 lightning talk.

[matthewfeickert]

👋 @crazy4pi314 following your great ⚡ talk today and that things seemed pretty simple in bluesky/tiled#522 I wanted to try to get this going for pyhf as well. I'll read https://containers.dev/ but if you also have time to discuss dev containers (or review this PR) before you leave SciPy 2023 that would be great! :)

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (4845a15) 98.30% compared to head (8daec08) 98.30%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2250   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4534     4534           
  Branches      802      802           
=======================================
  Hits         4457     4457           
  Misses         45       45           
  Partials       32       32           

Flag	Coverage Δ
contrib	97.88% <ø> (ø)
doctest	61.09% <ø> (ø)
unittests-3.10	96.31% <ø> (ø)
unittests-3.11	96.31% <ø> (ø)
unittests-3.8	96.33% <ø> (ø)
unittests-3.9	96.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[ltalirz]

I'll let @crazy4pi314 give the final answer here, but my understanding is that those extensions are not actually necessary here, unless you want to connect to a remote container / codespace from inside the dev container (of course the extensions should not hurt either).

[matthewfeickert]

unless you want to connect to a remote container / codespace

While the pyhf dev team doesn't actively use Codespaces at the moment (very cool, but not clear if the cost is worth it atm for us) we would like for others to be able to use Codespaces or Gitpod for demos and to help people making contributions get onboarded. Do these extensions help / become needed there?

[crazy4pi314]

Yeah I think they are probably not needed, Its likely my fault that I was exporting envs and those got installed as needed (but you don't have to proactively).

Gitpod I think has some very inital support for dev container config, so I am not sure if they would be helpful there yet :)

[matthewfeickert]

Thank you @crazy4pi314 and @ltalirz! 🚀