search

codecheckers / codecheck-py

Python-based template for writing CODECHECK certificates
MIT License
0 stars 0 forks source link

Add template by Marcel #1

Open nuest opened 3 years ago

nuest commented 3 years ago

For certificate 2021-001, @mstimberg created a great Jupyter notebook for writing the certificate PDF. Let's put it into a proper repository for reuse by others (and @mstimberg og voutdr ).

mstimberg commented 3 years ago

Happy to contribute a template! In my codecheck, I put all the code in the jupyter notebook itself, since I was developing things along the way, but it would probably sense to put the main functionality into a little independent module. This would make the jupyter notebook more readable and also be more similar in its approach to the R module that you and @sje30 created.

Maybe I'll rewrite the notebook of my codecheck first (to make sure that this approach actually works correctly) and once the codecheck is finalized, I'll copy it over here and convert it into a basic template?

nuest commented 3 years ago

I leave that up to you.

We welcome your contributions very much, but I don't want to overstretch your time, so I'm happy to do the test run myself with the next check that I do or have another community member give feedback later. We can mark the template as alpha stage in the README.

mstimberg commented 3 years ago

Appreciated, but moving the logic out into a separate file isn't too much work and I've mostly done it on my local machine already. I'll bring it over here after the codecheck is finalized, but will certainly consider it alpha and not make it an installable package at the moment.