Use lint tool about gwsl-source

[vasilvestre]

Not for Py, but Github action is free (and should be ok for your needs)

[sanzoghenzo]

HI, here's a list of good tools that comes in handy

• black for formatting;
• mypy for type checking;
• flake8 (and plugins) for linting;
• autoflake to fix some lint errors automatically;
• isort (I prefer reorder-python-imports) to... reorder python imports 😉;
• pre-commit to run the aforementioned tools when creating a commit.

Basically, you just need to add some configuration files for those tools, do pip install pre-config and pre-commit install;
this way the pre-commit hooks are installed and run everytime you do a commit.
You can also run it manually on every file of the project via pre-commit run --all-files;
There's also the official github action that will run the checks on the commits and PRs (useful if contributors forget to install the hooks).

Obviously I would also add pytest for unit testing and pytest-cov to make sure your code is properly tested.
The github documentation explains how to create a github action for pytest.
For better insights on the code coverage, you can use codecov.

I can setup something for, but some settings are subjective.
The first thing to choose is the desired line length; I've settled with 80 for my projects, so that I can have two panes in my IDE for faster copy/pasting or testing, etc.

[sanzoghenzo]

To configure pylint behaviour you have to put a pylintrc in the root directory.
To disable specific checks on lines or entire modules see the FAQ.
Also, since pylint is a static checker, you don't need to install the dependencies of your project.

[Pololot64]

That sounds good. I unfortunately do not have experience with linters or "CI"'s. Any recommendations?

[Pololot64]

I have the github action for pylint turned on at the moment. What annoys me is that the big things it dislikes are not changeable and are necessary for the code to work. I am not sure how to git around this.