Skip to content

Edit piwheels section of key projects#692

Merged
di merged 1 commit intopypa:masterfrom
bennuttall:patch-1
Feb 9, 2020
Merged

Edit piwheels section of key projects#692
di merged 1 commit intopypa:masterfrom
bennuttall:patch-1

Conversation

@bennuttall
Copy link
Copy Markdown
Contributor

Thanks to @brainwane for adding piwheels to key projects in #691. Just wanted to propose a couple of small changes:

  • un-capitalise Piwheels -> piwheels
  • use canonical url "www.piwheels.org"
  • change "some devs use piwheels as primary index" -> "Raspbian is pre-confiigured to use piwheels as an additional index"

@bennuttall bennuttall requested a review from brainwane February 4, 2020 09:40
Comment thread source/key_projects.rst
computers. Many Raspberry Pi users who use or develop Python tools to
run on Raspbian use Piwheels as their primary Python package index.
computers. pip in Raspbian is pre-configured to use piwheels.org as
an additional index to PyPI.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it additional? I have a feeling that it is the main one and PyPI is additional. It probably goes first because Pip seems to find things there if they exist, which only depends on the loading order...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how it's configured:

[global]
extra-index-url=https://www.piwheels.org/simple

It's only generally "first" because pip prioritises bdist over sdist. If both provided bdist, it would go with PyPI.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my experience, if both have exactly the same wheel, piwheels one is selected. I think, I asked @pradyunsg about multiple indexes and he told me that whatever is found first wins, meaning that if indexes are randomly ordered internally, there's no guarantee that one will be prioritized over the other. Hence different people can get slightly different behavior...

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The behaviour is not random; index-url is always first, extra-index-url are selected based on the order of declaration. The above config would choose PyPI over piwheels (if the project publishes pi-compatible wheels).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, then there's a bug. Because I hit the behavior I described a few times with Raspbian...

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you could file a bug with a minimum repro in pip's issue tracker, that'd be great! ^>^

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's more likely that was for another reason. If you can reproduce can you share with me? An issue on piwheels would be fine.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pradyunsg I think that the last time I faced it (cherrypy/cherrypy#1837 (comment)) is happening because of that scenario I sent you in Telegram. Not sure about the previous time which was about a year ago, I won't be able to reproduce the conditions now, I think. Maybe it was the same, maybe not.

@bennuttall looks like it's essentially because of piwheels/piwheels#208. So there's nothing else to file. Except maybe for an issue on the pip tracker with a proposal to improve warnings in this case.

Comment thread source/key_projects.rst
binary wheels that are optimized for installation onto Raspberry Pi
computers. Many Raspberry Pi users who use or develop Python tools to
run on Raspbian use Piwheels as their primary Python package index.
computers. pip in Raspbian is pre-configured to use piwheels.org as
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm not mistaken, Pip preferred spelling is capitalized:

Suggested change
computers. pip in Raspbian is pre-configured to use piwheels.org as
computers. Pip in Raspbian is pre-configured to use piwheels.org as

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...or not. But it still seems weird that the first word in the sentence is lowercase

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"pip" is not capitalised anywhere else on that page. Yes it does seem weird at the start of a sentence. "conda" starts three sentences and two are capitalised...

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preferred version seems to be “pip” since all occurrences on the documentation’s main page are lowercased.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep -- the preferred capitalization for pip is indeed all lowercase. I want to note that explicitly somewhere in our documentation but haven't spent the time to figure out the right place to do so + do a push to fix incorrect occurrences in various visible places.

@brainwane
Copy link
Copy Markdown
Contributor

brainwane commented Feb 4, 2020 via email

Copy link
Copy Markdown
Contributor

@brainwane brainwane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update @bennuttall!

@di di merged commit 129471f into pypa:master Feb 9, 2020
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.

6 participants