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
This commit is contained in:
Curtis Maloney 2024-06-14 00:03:24 +10:00 committed by GitHub
parent cd461f1243
commit 0fda89cd4d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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`.