Skip to content

Commit 5bb1b58

Browse files
jvolkmanalexeagle
andauthored
Remove 'experimental' from pip_parse section (#551)
Removes the "Experimental" tag from the `pip_parse` section of the README, and adds a note about the relatively new `compile_pip_requirements` rule. Co-authored-by: Alex Eagle <[email protected]>
1 parent e98bc2d commit 5bb1b58

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
120120
updating your system `python` interpreter), you can completely flush out your
121121
repo cache with `bazel clean --expunge`.
122122

123-
### Fetch `pip` dependencies lazily (experimental)
123+
### Fetch `pip` dependencies lazily
124124

125125
One pain point with `pip_install` is the need to download all dependencies resolved by
126126
your requirements.txt before the bazel analysis phase can start. For large python monorepos
@@ -131,9 +131,9 @@ file of all your python dependencies `pip_parse` will translate each requirement
131131
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
132132

133133
There are API differences between `pip_parse` and `pip_install`:
134-
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this using
135-
`pip-compile`, or a virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of `requirements`
136-
to make this distinction clear.
134+
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
135+
running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
136+
`requirements` to make this distinction clear.
137137
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
138138
declare your dependencies.
139139

0 commit comments

Comments
 (0)