Initial Release

[maxfischer2781]

This PR prepares the repo for the initial release. Notable changes include:

• Added test setup for YAML plugins and applied it to all existing plugins
• Proper version number matching the COBalD version scheme
• Expanded docs to be release-ready
  • README.md is suitable as a pypi description
  • index.rst is suitable as a RTD landing page
• Removed PyPy unittests since a secondary dependency does not support it

---

Since this is the initial release, I will manually trigger a release when this PR is merged.

[codecov-commenter]

Codecov Report

Merging #2 (9f3fabf) into master (dee811f) will decrease coverage by 1.59%.
The diff coverage is 88.46%.

@@            Coverage Diff             @@
##           master       #2      +/-   ##
==========================================
- Coverage   94.11%   92.52%   -1.60%     
==========================================
  Files           6        6              
  Lines          85      107      +22     
  Branches       13       20       +7     
==========================================
+ Hits           80       99      +19     
- Misses          5        6       +1     
- Partials        0        2       +2     

Impacted Files	Coverage Δ
tests/utility.py	87.50% <81.25%> (-12.50%)	⬇️
cobald_hep_plugins/__init__.py	100.00% <100.00%> (ø)
cobald_hep_plugins/example.py	100.00% <100.00%> (ø)
tests/test_example.py	100.00% <100.00%> (ø)
tests/test_stopper.py	100.00% <100.00%> (ø)

---

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 dee811f...9f3fabf. Read the comment docs.

[eileen-kuehn]

I left some comments regarding the current README.
Otherwise looks great! Thanks for all that amazing work 🚀

[giffels]

I would second the changes requested by Eileen and have nothing to add.

[maxfischer2781]

Thanks for taking a look. I should have all the comments covered now; added an issue for documenting the version scheme.

[eileen-kuehn]

Great work, go for it 🚀

[giffels]

Thanks a lot. Ready to merge!