Pre-commit hook with black
#5
Merged
Conversation
This file contains 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
|
@nathaniel-hudson Any chance you could put the steps from this PR in the main README as well? |
|
@msakarvadia, just added instructions to the README. |
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.
Adds a pre-commit hook for
black.Main Change
There will need to be some user-side configuration. Namely, the following steps:
pip install black(added torequirements.txt).pre-commitviapip install pre-commit(added torequirements.txt).pre-commit installto setup the pre-commit hooks.Once these steps are done, you just need to add files to be committed and pushed and the hook will reformat any Python file that does not meet Black's expectations and remove them from the commit. Just re-commit the changes and it'll be added to the commit before pushing.
Other Change(s)
I separated out the Cuda requirements into a separate requirements file (namely,
requirements-cuda.txt). This is just for those that might need to install the library for for basic tests on a device that is not Cuda-enabled.