🚸 Add extra safety measures, better documentation, better logging, and a separate test to avoid invalid notebook states

[falexwolf]

Add extra safety with a SystemExit and much clearer logging, stratified by interactive vs. non-interactive.

Jupyter Notebook:

VS Code:

Jupyter Lab:

[github-actions]

🚀 Deployed on https://62ce58644a94a13cbafcbece--nbproject-3aa23rammb.netlify.app

[codecov]

Codecov Report

Merging #153 (acb7f7c) into main (ab4dadc) will decrease coverage by 2.73%.
The diff coverage is 72.72%.

@@            Coverage Diff             @@
##             main     #153      +/-   ##
==========================================
- Coverage   79.75%   77.01%   -2.74%     
==========================================
  Files          17       17              
  Lines         800      805       +5     
==========================================
- Hits          638      620      -18     
- Misses        162      185      +23     

Impacted Files	Coverage Δ
nbproject/dev/_meta_store.py	88.23% <50.00%> (ø)
nbproject/_header.py	88.88% <75.00%> (-0.40%)	⬇️
nbproject/dev/_jupyter_lab_commands.py	33.33% <100.00%> (ø)
nbproject/_nbproject_cli.py	62.50% <0.00%> (-15.18%)	⬇️
nbproject/dev/_dependency.py	79.16% <0.00%> (-4.17%)	⬇️
nbproject/_schemas.py	95.55% <0.00%> (-1.12%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 439fc00...acb7f7c. Read the comment docs.

[falexwolf]

Coverage result without the test:

[falexwolf]

Ohhhhhhhh. I can't trigger the SystemExit, because the CLI uses the guides directory as an nbproject folder... That shouldn't be the case! This is what the example project is for. 😅

We need a controlled test environment in the guides directory.

[falexwolf]

Without interference of different parts of the testing setup.

Hence, this commit: f113c7a

@Koncopd, is this OK from your perspective? Or does this interfere with any of the rationales you though about when writing the CLI tests? Is it good enough to use example-project as a test for the CLI?

[falexwolf]

Now the tests are passing, and trigger-system-exit-upon-init now covers what had previously been covered by the initialize.ipynb notebook.

However, due to no longer running the CLI on all guides, we lose coverage in other parts of the code base:

[falexwolf]

We need to restore these parts of the code base by constructing a clean isolated test case for the CLI in the example-project and potentially another folder, if needed.

@Koncopd, happy to discuss this!