Services/Programs/Templates to use

[krischer]

We have to decide which services/program/templates to use for the various parts in the example we develop. I assume that participants will just follow these but they are of course free to choose their own.

git Hosting

Possibilities: github, gitlab, bitbucket, ?

I guess github is the obvious choice here although I personally really like the fully integrated approach gitlab is taking.

Programming language for the example

Python 3.7?

License

MIT/BSD

There are good arguments against the GPL variants in the context of scientific software but we of course also have to mention these.

Code of Conduct

https://www.contributor-covenant.org/ but there are many options.

We should probably also mention the various controversial arguments that have popped up over the last years over code of conducts and so on.

Unit testing in Python

I feel like pytest is the only sensible options these days.

CI

travis CI, circle CI, ... gitlab also has a really powerful CI system but it works best when using gitlab

circle CI tends to finish a lot faster which might be useful. But I can live with either choice.

Documentation

readthedocs is probably the only option for hosting. For writing the documentation we could either using sphinx or mkdocs (both work on readthedocs).

[lheagy]

Excellent! I think since we are already on github, it is natural to stick with that for now, we can make mention of other platforms during the presentation

Do we want to live-demo these things? or pre-cook them here in the repo?

Or a middle ground: we could start a branch that has all of these items already? (it is helpful to have the answer somewhere in case we get tripped up)