chore: isolate dev dependencies into [dev] extra #440
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
arHSM
reviewed
Jan 19, 2022
setup.py
Outdated
|
|
||
|
|
||
| def read_requirements(filename): | ||
| return open(filename).read().strip().splitlines() |
Contributor
There was a problem hiding this comment.
i think this should be replaced with the context manager
def read_requirements(filename):
with open(filename, "r", encoding="utf-8") as req:
return req.read().strip().split()
Contributor
Author
There was a problem hiding this comment.
Thanks, updated :)
Move code quality and documentation dependencies into an the [dev] extra. Prevents unnecessarily force-installing these libraries for downstream users and potentially creating version conflicts in their projects.
Contributor
|
Looks good to me, thank you for contributing! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
About
Fixes #398
Move code quality and documentation dependencies into an the [dev] extra. This will stop force-installing code quality tools in projects that make use of this library, in order to prevent a large amount of unnecessary code and potential version conflicts.
Checklist
pre-committo format and lint the change(s) made.3.8.6and higher.Additional Notes
I have not changed any of the requirements in this PR. However, libraries in
requirements-lint.txtcan be removed completely since this project uses pre-commit for linting. pre-commit does not rely on the user's current environment and thus does not require these libraries to be installed. Since linting options are specified in pre-commit scripts instead of config files, running these tools manually is error prone, so it may be a better idea to simply not include them and instead direct contributors to run them with precommit, e.g.pre-commit run flake8I can create a new issue/PR for this or add it to this PR if needed.