Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(quality): add quality tools #316

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

stegayet
Copy link

@stegayet stegayet commented Jan 3, 2023

Description

This PR intends to add quality tools (flake8, black, pyupgrade, mypy), locally using pre-commit and in the CI.

Technical details

  • Add flake8 and run the tool on the codebase
  • Add black and run the tool on the codebase
  • Add pyupgrade and run the tool on the codebase
  • Add mypy and run the tool on the codebase

TODO

  • Add related documentation in README
  • Add CI checks
  • Finish mypy integration
  • Add isort
  • Add check-yaml

Future work

  • With mypy running on the codebase, add py.typed marker so that library usage of external projects can also be type-checked.

@simo5
Copy link
Member

simo5 commented Jan 3, 2023

Looks like this PR is making a massive amount of trivial changes.
Can you please match the ignores already present in tox.ini ?

I am all for more linters, but I am not going to accept massive changes where all that changes is the type of python quoting used or similar changes, the code base is to big and mature for that kind of change, it would clobber history (git blame) for no good reason.

@stegayet
Copy link
Author

stegayet commented Jan 4, 2023

Agreed, I'll proceed to changes and ping you once this PR is ready to be reviewed 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants