diff options
author | Jonathon Belotti <jonathon@canva.com> | 2022-05-10 21:19:20 +1000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-10 07:19:20 -0400 |
commit | e8e927b948af902eb93a801352af1416f35538e8 (patch) | |
tree | 7c525bf3af8d6c3086d71cfefeae6637b865d644 /README.md | |
parent | ed6bf1595252c4162cec889919c22a151e9191c5 (diff) | |
download | bazelbuild-rules_python-e8e927b948af902eb93a801352af1416f35538e8.tar.gz |
Add caveat about python_register_toolchain's hermeticty to README (#698)
* Add caveat about `python_register_toolchains` rule's hermeticity.
* Fix typos and grammar
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -54,7 +54,9 @@ http_archive( ) ``` -To register a hermetic Python toolchain rather than rely on whatever is already on the machine, you can add to the `WORKSPACE` file: +### Toolchain registration + +To register a hermetic Python toolchain rather than rely on a system-installed interpreter for runtime execution, you can add to the `WORKSPACE` file: ```python load("@rules_python//python:repositories.bzl", "python_register_toolchains") @@ -77,8 +79,11 @@ pip_parse( ) ``` -> You may find some quirks while using this toolchain. -> Please refer to [this link](https://python-build-standalone.readthedocs.io/en/latest/quirks.html) for details. +After registration, your Python targets will use the toolchain's interpreter during execution, but a system-installed interpreter +is still used to 'bootstrap' Python targets (see https://github.com/bazelbuild/rules_python/issues/691). +You may also find some quirks while using this toolchain. Please refer to [python-build-standalone documentation's _Quirks_ section](https://python-build-standalone.readthedocs.io/en/latest/quirks.html) for details. + +### "Hello World" Once you've imported the rule set into your `WORKSPACE` using any of these methods, you can then load the core rules in your `BUILD` files with: |