Setup linter / formatter for python

[Enzyme3]

Overview

We need to ensure that all backend developers who are contributing to the project are committing code that is stylistically consistent and follows general best practices. The usage of linters and formatters will help enforce this consistency.

Action Items

• Determine linters / formatters to be used
• Determine how the linters / formatters will be triggered
• Implement

Resources/Instructions

• Super-Linter is already setup as a Github action, but its use has been disabled for python files. Based on my current understanding, I am not certain if we should solely rely on this because:
  • It can suggest fixes, but cannot automatically apply them, which makes it suitable for linting, but not really for formatting
  • Cannot natively install python dependencies, which results in lots of import errors for django modules. Technically, there appears to be a workaround but sounds kludgey and brittle
  • bad developer UX. Instead of listing all of the lint errors, the errors are displayed on a per-file basis, i.e. with lots of boilerplate text in between each file. Have to do lots of scrolling to view the relevant messages
  • slow. even after container is up, much slower than one would expect for a linter

[Enzyme3]

Have investigated the use of pre-commit instead and made #259 to address
Uses the same libs that were commented out in super-linter: isort, pylint, flake8 and black