ocean-data-factory-sweden / kso

Notebooks to upload/download marine footage, connect to a citizen science project, train machine learning models and publish marine biological observations.
GNU General Public License v3.0
5 stars 12 forks source link

Add CI checks for input arguments, spelling, more? #241

Open Diewertje11 opened 1 year ago

Diewertje11 commented 1 year ago

Look up what kind of checks we can add to assure code quality:

Diewertje11 commented 1 year ago

Pylint is added to kso_utils in MR 166 in kso_utils.

However, note: Pylint is not picking up all errors. In project.py we are calling for tutorial_utils.get_annotator() and this one does not exist in tutorial_utils. However, we do not get an error for this, while we should. This might be a bug in Pylint and needs further investigation.

Also note, currently we install pytest and pylint separately when we do the tests, we might want them to just be included in the container. If so, we need to change this.

Still need to do:

Diewertje11 commented 1 year ago

MR 181 in kso_utils fixes the problem of not recognising the get_annotator as error. The other to-do's are not done yet.

Diewertje11 commented 1 year ago

The spelling check we have included in another issue.

All other points are resolved in the commits where we removed the submodule of kso_utils and converted it into a folder. (commit e755c7c)

It was decided that pylint and pytest were only installed for testing and not in the requirements, since we do not need it anywhere else, so we do not want to make the container include even more packages.