Pre-commit and poetry tasks

kaitj commented 2 years ago

Proposed changes

This PR adds the following:

Poetry task to perform testing
Poetry task for quality checking
- This currently includes flake8 and pylint, but we should go through and figure out resolving errors
Pre-commit hooks
- Also includes flake8 and pylint, but for now this is commented out.

I have pointed this PR to poetry_setup rather than master as that should be merged first.

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

[ ] Bugfix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Other (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

[x] Changes have been tested to ensure that fix is effective or that a feature works.
[ ] Changes pass the unit tests
[ ] Code has been run through black with the -l 79 flag.
[ ] I have included necessary documentation or comments (as necessary)
[ ] Any dependent changes have been merged and published

Notes

All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

_PR template was adopted from appium_

kaitj commented 2 years ago

Did we want to try to resolve potential warnings as part of this PR or separate (the linting is likely still to fail or output a long list for now).

tkkuehn commented 2 years ago

Lets fix the rest of them in a separate PR

tkkuehn commented 2 years ago

Oh, should we use poethepoet in the quality check actions now?

kaitj commented 2 years ago

This was actually a question I had when I was looking at the snakebids actions since this basically copies that workflow. The action and the poe task differ in one minor way: the poe task actually performs the sorting and corrections but the action only performs checks for isort and black.

Thinking about it some more, if we resolve all the warnings and ensure pre-commit is run, than we can update the poe task to perform the check and use that in the action.

tkkuehn commented 2 years ago

Yeah I don't think we'll want to perform the corrections in the workflow, so I'm fine either way.

afids / afids-validator