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

there is very little documetation for the --target flag #12667

Open
1 task done
whitequill opened this issue May 1, 2024 · 3 comments
Open
1 task done

there is very little documetation for the --target flag #12667

whitequill opened this issue May 1, 2024 · 3 comments
Labels
C: target pip install's --target option's behaviour handling help wanted For requesting inputs from other members of the community type: docs Documentation related

Comments

@whitequill
Copy link

What's the problem this feature will solve?

I want to bring awareness to the lack of documentation of the flag --target. I was building a version of blender and I wanted it to have its own python that I cloned into ./blender/extern. This posed a problem cause when I was installing python into extern there isn't an obvious way to use pip to install to a specified path. One can look at the documentation and man file and info file and there is no mention of the --target flag anywhere.

I'm sure there are others who need to install pip packages to a custom path. Why is there no documentation on official sources?

Describe the solution you'd like

I would like documentation of the --target flag to be included in all official documentation and be easily findable though search engines.

Alternative Solutions

post documentation of forums and other supplemental media about the `--target' flag and its uses.

Additional context

I feel what I have written is clear and I don't feel any additional context is needed. the --target flag either needs to be better documented or information about its deprecation needs to be documented and publicized.

Code of Conduct

@whitequill whitequill added S: needs triage Issues/PRs that need to be triaged type: feature request Request for a new feature labels May 1, 2024
@whitequill
Copy link
Author

the way I am using the --target flag is like this:
sudo ${HOME}/gitrepos/blender/extern/python/bin/pip3.12 install pybullet requests zstandard numpy brotli pyblas numpy --target ${HOME}/gitrepos/blender/extern/python/lib/python3.11/site-packages

@pfmoore
Copy link
Member

pfmoore commented May 1, 2024

While your point about documentation is fair (there is some documentation, under the command options for pip install) for this use case I think you should be using --prefix.

Documentation on the use of, and differences between, --prefix, --root, and --target would be useful, the problem is likely to be finding someone who understands the subtle differences and which flags are appropriate for which use cases 🙁

@whitequill
Copy link
Author

whitequill commented May 1, 2024

I did find the information here on the official webpage: https://pip.pypa.io/en/stable/cli/pip_install/.
Google and other search engines don't send you here when one is looking for the information.

@ichard26 ichard26 added type: docs Documentation related C: target pip install's --target option's behaviour handling help wanted For requesting inputs from other members of the community and removed type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: target pip install's --target option's behaviour handling help wanted For requesting inputs from other members of the community type: docs Documentation related
Projects
None yet
Development

No branches or pull requests

3 participants