How does Pepy decide if something is a "CI Download"

[Mrc0113]

I see a toggle on the site to include/exclude "CI Downloads". How does Pepy determine if it's a CI download or not?

[hugovk]

Clients like pip detect if they're running on a CI by checking for coom9n environment variables, and include that in the user agent they send to PyPI, which then includes it in the BigQuery data.

For example:

• https://github.com/pypa/pip/blame/6ce7217a535e4efc56ab066e069ff2bdcd623c04/src/pip/_internal/network/session.py#L31-L58
• Differentiating organic vs automated installations pypa/pip#5499

[Mrc0113]

Thank you @hugovk, that gives me the answer I need!

[Mrc0113]

@hugovk does the PIP_IS_CI variable just need to be present or should it be set to true or 1 or something else?

[hugovk]

Most CIs already set some of the env vars. See the comment in the link above. For example, most set CI, and Jenkins sets BUILD_ID.

If you use some other CI that doesn't set these, you can exlicity set PIP_IS_CI instead.

It doesn't matter what the value is, just that it exists:

https://github.com/pypa/pip/blame/6ce7217a535e4efc56ab066e069ff2bdcd623c04/src/pip/_internal/network/session.py#L58

[Mrc0113]

Thanks, it looks like github actions doesn't already set one that is included which is why I was asking

[hugovk]

GitHub Actions has had CI for five years:

• https://github.blog/changelog/2020-04-15-github-actions-sets-the-ci-environment-variable-to-true/
• https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables