In case you contribute code, we generally ask for following the code style we are using already. This is a general Python style, with 4 spaces as the delimiter, nothing groundbreaking here :)
Import sorting is controlled by isort. There is a helper script
to reformat the code under support/run_formatter.py
and the tests
will also verify this formatting.
For code formatting we use Flake8. You can find a .flake8
configuration file in the root directory.
Additionally we check for code errors with Pylint. We provide a
.pylintrc
file in the root directory which defines differences from the default
Pylint configuration. Your IDE may help with linting your code too!
Python supports a number of different logging patterns - for more information see Pyformat and Formatting python log messages. We request that the new format style is followed e.g.
logger.info("Fetching common steps from '{}'.".format(url))