Add Python Code Linting For gempyor
#279
Labels
gempyor
Concerns the Python core.
high priority
High priority.
meta/workflow
Relating to CI / issue templates / testing frameworks / etc.
Currently there is no enforced style guide for the python code contained in
gempyor
which can make it difficult to approach the code base for new developers as well as make it challenging to conform code from multiple developers into one cohesive code base. While there is a learning curve associated with these tools and some work to get them setup they will make PR review much smoother and create consistent enforceable guidelines for contributing.There are multiple options, but I suggest we use black autoformatter and/or pylint static analyzer to clean up
gempyor
and enforce consistent styling.pylint
seems to be much stricter thenblack
, butblack
has the ability to reformat your code for you. Perhaps a compromise approach is starting withblack
and then upgrading topylint
. But some general steps that need to be taken are:black
to the python code base.black
, probably in the contributing portion of the gitbook documentation.pylint
either going file by file or limiting to--errors-only
initially.The text was updated successfully, but these errors were encountered: