Inclusion of Github actions for CI?

[wweijtje]

One of the most efficient ways to improve code quality for packages is to include a pipeline that is triggered on e.g. a commit on master or when a pull request is launched. These tools force a certain level of quality and e.g. prevent to commit a version that fails the unittests.

Typical steps are:

• run unittest
• linting the code (e.g. blacken)
• check compliance with e.g. PEP8
• update the version number (e.g. major/minor release)
• build documentation
• publish on pypi (e.g. only when a merge on the main branch is done)

At least a part of these actions can be readily achieved through github actions: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

Some examples :

• in our peak splitting package: https://github.com/OWI-Lab/py_peak_splitting/blob/main/.github/workflows/python-publish.yml
• in fatpack : https://github.com/Gunnstein/fatpack/blob/master/.github/workflows/publish-to-pypi.yml

Tradeoff here is to balance complexity (too many elements increases the risk for the pipeline to fail and thus frustration) against the gain (higher Quality).

[jankoslavic]

This is great! Thank you @wweijtje !
This is a relatively easy task, I have marked it as "help wanted" to give the community the opportunity to join the effort. I guess somebody with prior experience could set-up this.

If it is not handled in a reasonable time, we I will take care of this. :)