Remove the rules_python_external README#391
Merged
thundergolfer merged 4 commits intomasterfrom Jan 10, 2021
Merged
Conversation
hrfuller
approved these changes
Dec 21, 2020
Contributor
hrfuller
left a comment
There was a problem hiding this comment.
LGTM. Up to your discretion to add the chunks I commented on to the top level README
Comment on lines
-77
to
-89
| # If you need to depend on the wheel dists themselves, for instance to pass them | ||
| # to some other packaging tool, you can get a handle to them with the whl_requirement macro. | ||
| filegroup( | ||
| name = "whl_files", | ||
| data = [ | ||
| whl_requirement("boto3"), | ||
| ] | ||
| ) |
Contributor
There was a problem hiding this comment.
Might be good to document this in the packaging rules.
Author
There was a problem hiding this comment.
I'll add a sub-section for it 👍
Comment on lines
-51
to
-61
| load("@rules_python_external//:defs.bzl", "pip_install") | ||
| pip_install( | ||
| name = "py_deps", | ||
| requirements = "//:requirements.txt", | ||
| # (Optional) You can provide a python interpreter (by path): | ||
| python_interpreter = "/usr/bin/python3.8", | ||
| # (Optional) Alternatively you can provide an in-build python interpreter, that is available as a Bazel target. | ||
| # This overrides `python_interpreter`. | ||
| # Note: You need to set up the interpreter target beforehand (not shown here). Please see the `example` folder for further details. | ||
| #python_interpreter_target = "@python_interpreter//:python_bin", | ||
| ) |
Contributor
There was a problem hiding this comment.
This example still seems useful to document the python_interpreter[_target] arguments.
Author
There was a problem hiding this comment.
Agreed. It documented in the README but in words not code examples.
thundergolfer
pushed a commit
that referenced
this pull request
Jan 3, 2021
…external README into root README. ref: #391
…external README into root README. ref: #391
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
PR Checklist
Please check if your PR fulfills the following requirements:
.parfiles. See CONTRIBUTING.md for infoPR Type
What kind of change does this PR introduce?
Description
This
READMEwas carried over during the merge ofrules_python_external, and it has info that's duplicating and sometimes contradictory of the documentation in the rootREADME. I'd favour just removing it.If there's anything in this
READMEthat you think should remain in the repo, I can pull it out and put it in the rootREADMEunder "Using the packaging rules".Does this PR introduce a breaking change?