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
Meta linting #88
Meta linting #88
Conversation
As I look towards automated liniting in Travis, I want to make sure that tests aren't going to break in unexpected fashions when the upstream test tooling is updated unexpectedly. Thus we lock these version using the output of `pip list --format freeze`. This means that these version will need to be periodically updated to capture the latest & greatest work, but those updates will happen in a controlled fashion (a git commit).
Although we had readme instructions referencing this, the version to use was not specified in requirements_test.txt. Lock it! Also, max-line-length = 100 per @deppen8's preferred style.
@deppen8 uses black for formatting all the code in this repo. Instead of having flake8 fight with it, lets officially add black to the toolchain.
The black version in the toolchain reflowed this file. In order to prevent PR build failure we need to fix in in the repo.
reqs/lint.txt
Outdated
pycodestyle==2.5.0 | ||
pyflakes==2.1.1 | ||
|
||
# flake8, top level |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
copypasta error: flake8
-> black
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM :) One thing we could add if desired is a README badge for black code style like https://github.com/psf/black#show-your-style.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just accept these couple changes and good to go!
This will categorically prevent flake8 or black regressions from entering the code base in the future. Fixes deppen8#83.
Trying to install zipp==2.2.0 on 3.5 results in the following error: Could not find a version that satisfies the requirement zipp==2.2.0 (from versions: 0.1.0, 0.2.0, 0.2.1, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.4.0, 0.5.0, 0.5.1, 0.5.2, 0.6.0, 1.0.0, 1.1.0)
Co-Authored-By: Jacob Deppen <deppen.8@gmail.com>
Co-Authored-By: Jacob Deppen <deppen.8@gmail.com>
49f263b
to
0141f79
Compare
post-merge of deppen8#88
This PR introduces flake8 and black to the toolchain and ensures they are run against every pull request.
Fixes #83.
In fact, this will categorically prevent #83 from ever regressing.
Testing done:
I enabled Travis on my fork. All pushes to this branch can be seen here:
https://travis-ci.org/wadells/pandas-vet/builds?utm_medium=notification&utm_source=github_status
It is currently green.
Furthermore, I also nuked & rebuilt my venv to test setup instructions.