From 0fda89cd4db44960a16ed33c9969aeba9d0c452e Mon Sep 17 00:00:00 2001 From: Curtis Maloney Date: Fri, 14 Jun 2024 00:03:24 +1000 Subject: [PATCH] Add `pip-compile` defaults to `PIP_COMPATIBILITY.md` (#4302) ## Summary Add details about differing defaults between `uv pip compile` and pip-tools `pip-compile` to PIP_COMPATIBILITY.md --- PIP_COMPATIBILITY.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/PIP_COMPATIBILITY.md b/PIP_COMPATIBILITY.md index 0311efe78..33f204583 100644 --- a/PIP_COMPATIBILITY.md +++ b/PIP_COMPATIBILITY.md @@ -367,3 +367,17 @@ occasionally found in Docker images and Conda environments) and (2) legacy edita Specifically, uv does not support installing new `.egg-info`- or `.egg-link`-style distributions, but will respect any such existing distributions during resolution, list them with `uv pip list` and `uv pip freeze`, and uninstall them with `uv pip uninstall`. + +## `pip compile` + +There are a few small but notable differences in the default behaviors of `pip compile` and +`pip-tools`. + +uv does not write the compiled requirements to file by default. Use the `-o` or `--output-file` +option. + +Currently, `pip-compile` defaults to `--no-strip-extras`, though this is scheduled to change in the +next major release. + +If your requirements file includes an `--extra-index-url` directive, uv will not emit it by +default. Use the `--emit-index-url` option. uv will also include its default `--index-url`.