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

docs: Add method of installation via conda #842

Merged
merged 1 commit into from
Nov 21, 2024
Merged

Conversation

GasinAn
Copy link
Contributor

@GasinAn GasinAn commented Nov 20, 2024

On conda-forge, this package is called "python-build", not "build". However, this information is only given in README.md and not in docs/installation.rst. Users are likely to read the documentation on https://build.pypa.io/ only, and they are likely to think that the name of the package on conda-forge is also "build", which will make them get into trouble. Fix this problem here.

On conda-forge, this package is called "python-build", not "build".
However, this information is only given in README.md and not in
docs/installation.rst.  Users are likely to read the documentation on
https://build.pypa.io/ only, and they are likely to think that the name
of the package on conda-forge is also "build", which will make them get
into trouble.  Fix this problem here.
@layday
Copy link
Member

layday commented Nov 20, 2024

Python libraries are typically prefixed with "python" in multi-language package indices, and conda-forge is one of many. I'm not sure we need to mention it specifically.

@henryiii
Copy link
Contributor

Conda is a very popular, OS agnostic way to install Python libraries. It comes up all the time when discussing packaging, etc, so I think it would be okay to mention. It's called python-build in the defaults channel too (it's still 0.10 there, though).

It was originally called build, but they renamed it and eventually dropped the out-of-date build-feedstock.

@henryiii
Copy link
Contributor

Also, very few packages have a python- prefix in conda.

@layday
Copy link
Member

layday commented Nov 20, 2024

Is it too late to rename this package to pyproject-build? 😄

@Secrus
Copy link
Member

Secrus commented Nov 21, 2024

Isn't this information already present in the README?

@henryiii
Copy link
Contributor

Yes, it is. Maybe we should try to make sure this is more similar to the readme.

@GasinAn
Copy link
Contributor Author

GasinAn commented Nov 21, 2024

The habit of conda users may be different from that of pip users and source code users: they often search for the documentation and read it first, and also, it may not be likely for them to realize that such an important information is only present in README but not in the documentation.

@henryiii
Copy link
Contributor

I think it was just an oversight that the same info wasn't added to the docs, in general docs should not have less information than the README. A README is an abbreviated version of the docs, usually.

@layday
Copy link
Member

layday commented Nov 21, 2024

We also mention pipx and uv in the readme. Let's add those here too.

@henryiii
Copy link
Contributor

Let's add those here too.

Agreed. Same PR or followup?

@layday
Copy link
Member

layday commented Nov 21, 2024

I don't mind, if @GasinAn would prefer to leave that to somebody else, we can do in a follow-up.

@GasinAn
Copy link
Contributor Author

GasinAn commented Nov 21, 2024

Sorry, I prefer to leave followup to somebody else, because I know few about pipx and uv.😐

@henryiii
Copy link
Contributor

No problem, we can follow it up. Thanks!

@henryiii henryiii merged commit 97b3de4 into pypa:main Nov 21, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants