Adding simple dev container
What does this implement/fix? Explain your changes
- Adding simple dev container s.t. new users can execute the tutorials right away and experiment with the toolkit w/o having to install it.
- Adapts the
READMEby explaining this option.
Does this close any currently open issues?
Fixes #1052, #554
Checklist
Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.
- [x] I have read and understood the contribution guidelines
- [x] I agree with re-licensing my contribution from AGPLv3 to Apache-2.0.
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] ~I have added tests that prove my fix is effective or that my feature works~
- [ ] ~I have reported how long the new tests run and potentially marked them
with
pytest.mark.slow.~ - [ ] ~New and existing unit tests pass locally with my changes~
- [ ] ~I performed linting and formatting as described in the contribution guidelines~
- [x] I rebased on
main(or there are no conflicts withmain)
@Ziaeemehr, once you have the image, I'll adapt the container to use it.
Our organization settings are such that anyone can directly create a code-space inside the sbi repository. This works already, opening a vs-code instance running in the browser. However, the required packages are not installed.
So I guess what is left to do is to find a way to pre-install the requirements defined in pyproject.toml on opening a new code-space.
@turnmanh or @Ziaeemehr would you be up for looking into this?
Yes, providing a pre-setup container incl. the dependencies was the goal for this PR. I'll look into it and provide the req. functionality @janfb.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 72.91%. Comparing base (
8efb8e4) to head (30f81ed). Report is 1 commits behind head on main.
:exclamation: Current head 30f81ed differs from pull request most recent head 0c4cc85
Please upload reports for the commit 0c4cc85 to get more accurate results.
Additional details and impacted files
@@ Coverage Diff @@
## main #1070 +/- ##
===========================================
- Coverage 83.69% 72.91% -10.79%
===========================================
Files 93 93
Lines 7397 7399 +2
===========================================
- Hits 6191 5395 -796
- Misses 1206 2004 +798
| Flag | Coverage Δ | |
|---|---|---|
| unittests | 72.91% <ø> (-10.79%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
@janfb, I've adapted the following:
- pipeline only runs once a release is published → makes sense as we only install the released version of the pkg.
- linked an overview of GH Codespaces to inform possible users
There is a conflict with the README on main. I can fix it and will merge it then 👍