bazel-contrib / bazel-contrib/rules_python

doc: howto configure bazel downloader with pip.parse

Open
#3,102 4 comments 1 reaction 0 assignees View on GitHub
type: documentation
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
15h 7m
Merged PRs (30d)
76

Description

I think I've seen this question a few times: I want to customize where wheels are downloaded from. What parameters do I set in (pip.parse or compile_pip_requirements) to do that?

When the answer is non-obvious: use bazel downloader to redirect the url requests.

This is mentioned in the regular pypi docs, but only briefly; it's easy to overlook.

We should give an example in the docs on how to do this.

A dedicated "how to" sub-directory of docs is probably a good idea. It'll be a good place to put prose documentation that draws people in, and we can easily expand it with arbitrary topics and content without it feeling out of place or bloating the more dry/technical/reference docs.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing PyPI documentation and the references to pip.parse and compile_pip_requirements. Add a how-to example showing how Bazel downloader redirects wheel URL requests, and organize it in a dedicated how-to documentation area if appropriate; done means the configuration is clearly documented for users customizing download locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.