Search and stores: how FoxPlug reads PyPI

PyPI

PyPI is the Python Package Index, the public registry where Python packages are published and installed with pip.

What it reads

• The project's public JSON: info.version (the latest release) and the first file of that release with its upload time iso 8601
• Downloads in the last month: last month from the public pypistats recent figures (optional: a failure is ignored)
• The project name you typed: up to 5 names, comma separated

Moments

• a project FoxPlug has read before has a different latest version. Your made-up project my-lib goes from 0.8.3 to 0.9.0. On the next Check for what's new FoxPlug writes 'Released my-lib 0.9.0' with 'my-lib 0.9.0 is published on PyPI.' and the project link, which can become a post and a changelog entry.
• downloads in the last month cross 100, 500, 1,000, 5,000, 10,000, 50,000, 100,000 and on up to 100,000,000. my-lib had 6,120 downloads in the last month at the last read. FoxPlug writes 'my-lib passed 5,000 downloads a month' with 'my-lib now has more than 5,000 downloads a month (6,120 at the last read).' Each step fires once.

Set up

1. Open pypi.org and find your project.
2. Copy the project name shown at the top of the page.
3. Paste it into FoxPlug. To watch several projects, separate them with commas (up to 5).
4. Press Connect.

What it never reads

• Any login or token of yours (it needs only a project name)
• The files of your releases (only the public JSON and download statistics are called)

How it differs

npm is near-identical in shape, but PyPI milestones count downloads in the last month (from pypistats) while npm milestones count total downloads since 2015-01-10; npm also keeps the last 30 versions to compare, PyPI compares only the single latest version.