Style guidelines

Python scripts are linted using the flake8 linter which combines the goodness of three other linters - pyflakes, pycodestyle, and mccabe. You can read more about the project and detailed configuration on their documentation page. This project uses vanilla flake8 with the max-line-length set to 99 characters.

If you want to test linting locally, install the flake8 module first:

$ pip3 install flake8

Then, simply navigate to your project root (if not there yet) and run the flake8 command:

$ cd clarity
$ flake8

If your project is linted properly, it should exit with no output, otherwise flake8 will provide a full list of errors, with a description, code, line and column number.

A full list of rules is available at https://www.flake8rules.com