Add flake8 linter workflow

[drikusroor]

Background

I've recently opened a PR (#865) that will add automated unit tests using Github workflow for every PR and commit on the master branch. The suggestion was made to also add flake8 linting, though in a separate PR, which you are looking at right now. I think it'd be a good idea to merge that other PR first and then append the workflow by merging this one.

Changes

• Add flake8 linting
• Add a flake8 linting job to the workflow (continue after error is set to true as there were still quite some linting issues)
• Rename the unit_tests.yml to ci.yml as it now contains more jobs than just unit tests

Documentation

I've added a small section to README.md that explains how to run the flake8 linter.

Test Plan

If the Python CI workflow succeeds the changes from this PR work as expected.

PR Quality Checklist

• My pull request is atomic and focuses on a single change.
• I have thoroughly tested my changes with multiple different prompts. (prompts N/A)
• I have considered potential risks and mitigations for my changes.
• I have documented my changes clearly and comprehensively. (needn't be comprehensive)
• I have not snuck in any "extra" small tweaks changes

[nponeccop]

I also suggest adding flake8 and the tests in a different PRs, and using the following small list of pep8 fixes:

python -m flake8 --select E303,W293,W291,W292,E305

This way we will start having pep8 but we won't break many PRs, and we gradually extend the list introducing minimal breakage.

[drikusroor]

I also suggest adding flake8 and the tests in a different PRs, and using the following small list of pep8 fixes:

python -m flake8 --select E303,W293,W291,W292,E305

This way we will start having pep8 but we won't break many PRs, and we gradually extend the list introducing minimal breakage.

The unit tests itself are added in a separate PR (here #865) already. I don't know if that's what you meant.

As for the python -m flake8 --select E303,W293,W291,W292,E305 command: Are you suggesting to first use this command and then in later PRs we gradually be more strict about it, or am I understanding you wrong? :-)

[nponeccop]

I don't know if that's what you meant.

Well, I apologize then. Yes as for getting stricter you are right.

[drikusroor]

I don't know if that's what you meant.

Well, I apologize then. Yes as for getting stricter you are right.

No worries, I was just wondering 😅

[richbeales]

Hi, your unit test PR has been merged, please can you resolve the conflicts in this one? Thanks