Introduce pre-commit to simplify contributions #866
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #866 +/- ##
=======================================
Coverage 97.74% 97.74%
=======================================
Files 60 60
Lines 3319 3319
=======================================
Hits 3244 3244
Misses 75 75 Continue to review full report at Codecov.
|
n2ygk
requested changes
Nov 22, 2020
There was a problem hiding this comment.
Consider adding something like the following to tox.ini as a mean of making it easy for someone to set up the venv:
[testenv:devenv]
envdir = env
basepython = python3.6
usedevelop = True
deps =
-rrequirements.txt
commands =
/usr/bin/printf '\n\033[0;31m dont forget to source env/bin/activate\033[0m\n'
n2ygk
reviewed
Dec 5, 2020
|
|
||
| To run tests clone the repository, and then: | ||
|
|
||
| # Setup the virtual environment |
There was a problem hiding this comment.
@sliverc my point of tox -e devenv is you can turn these several steps into one.
n2ygk
approved these changes
Dec 5, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #861
Description of the Change
Add pre-commit for editor independent checking of linting and formatting of code before committing changes to git.
I have added a pre-commit configuration which uses the locally resp. in the virtual environment installed version of flake8, isort and black. pre-commit also has a way of handling the installation of such tools. However PyUp cannot update those version references and we might end up with different version in pre-commit and requirements.txt which we should avoid.
The only down side to run tools locally is that a virtual env needs to be activated before committing. This needs to be the case anyway to run tests.
Checklist
CHANGELOG.mdupdated (only for user relevant changes)AUTHORS