Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FR] Offer an example usage command in the default header comment #2064

Open
webknjaz opened this issue Mar 1, 2024 · 2 comments
Open

[FR] Offer an example usage command in the default header comment #2064

webknjaz opened this issue Mar 1, 2024 · 2 comments
Labels
annotations Related to packages annotations enhancement Improvements to functionality writer Related to results output writer component

Comments

@webknjaz
Copy link
Member

webknjaz commented Mar 1, 2024

What's the problem this feature will solve?

There's confusion as to how the output files are to be used and the header only shows how they were generated.

Describe the solution you'd like

I want the header to have an example on using the generated files as constraint. Specifically, suggesting to perform the installation via PIP_CONSTRAINT=requirements.txt pip install -r requirements.in -c requirements.txt. With the proper filenames, of course.

Alternative Solutions

Letting the confusion live on..?

Additional context

This idea occurred to be having observed how different people have different expectations about using the pip-compile generated files in #2051.

@webknjaz webknjaz added enhancement Improvements to functionality writer Related to results output writer component annotations Related to packages annotations labels Mar 1, 2024
@chrysle
Copy link
Contributor

chrysle commented Mar 1, 2024

Is explicitly specifying PIP_CONSTRAINT needed when using the -c option on the command line?

@webknjaz
Copy link
Member Author

webknjaz commented Mar 1, 2024

Is explicitly specifying PIP_CONSTRAINT needed when using the -c option on the command line?

This is for the constraints to leak into the ephemeral PEP 517 build env provisioning subprocess.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
annotations Related to packages annotations enhancement Improvements to functionality writer Related to results output writer component
Projects
None yet
Development

No branches or pull requests

2 participants