Skip to content

docs: Add method of installation via conda - #842

Merged
henryiii merged 1 commit into
pypa:mainfrom
GasinAn:main
Nov 21, 2024
Merged

henryiii merged 1 commit into
pypa:mainfrom
GasinAn:main

Conversation

@GasinAn

@GasinAn GasinAn commented Nov 20, 2024

Copy link
Copy Markdown
Contributor

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

layday commented Nov 20, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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
Copy Markdown
Contributor

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

@layday

layday commented Nov 20, 2024

Copy link
Copy Markdown
Member

Is it too late to rename this package to pyproject-build? πŸ˜„

@Secrus

Secrus commented Nov 21, 2024

Copy link
Copy Markdown
Member

Isn't this information already present in the README?

@henryiii

Copy link
Copy Markdown
Contributor

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

@GasinAn

GasinAn commented Nov 21, 2024

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown
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

layday commented Nov 21, 2024

Copy link
Copy Markdown
Member

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

@henryiii

Copy link
Copy Markdown
Contributor

Let's add those here too.

Agreed. Same PR or followup?

@layday

layday commented Nov 21, 2024

Copy link
Copy Markdown
Member

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

@GasinAn

GasinAn commented Nov 21, 2024

Copy link
Copy Markdown
Contributor Author

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

@henryiii

Copy link
Copy Markdown
Contributor

No problem, we can follow it up. Thanks!

@henryiii
henryiii merged commit 97b3de4 into pypa:main Nov 21, 2024
@GasinAn GasinAn mentioned this pull request Nov 28, 2024
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