A rule for importing requirements.txt dependencies into Bazel.

This rule imports a requirements.txt file and generates a new requirements.bzl file. This is used via the WORKSPACE pattern:

pip_repository(
    name = "foo",
    requirements = ":requirements.txt",
)

You can then reference imported dependencies from your BUILD file with:

load("@foo//:requirements.bzl", "requirement")
py_library(
    name = "bar",
    ...
    deps = [
       "//my/other:dep",
       requirement("requests"),
       requirement("numpy"),
    ],
)

Or alternatively:

load("@foo//:requirements.bzl", "all_requirements")
py_binary(
    name = "baz",
    ...
    deps = [
       ":foo",
    ] + all_requirements,
)

A unique name for this repository.

Optional annotations to apply to packages

Whether this repository rule is invoked under bzlmod, in which case we do not create the install_deps() macro.

Whether to use "pip download" instead of "pip wheel". Disables building wheels from source, but allows use of --platform, --python-version, --implementation, and --abi in --extra_pip_args to download wheels for a different platform from the host platform.

If true, disables conversion of native namespace packages into pkg-util style namespace packages. When set all py_binary and py_test targets must specify either legacy_create_init=False or the global Bazel option --incompatible_default_to_explicit_init_py to prevent __init__.py being automatically generated in every directory.

This option is required to support some packages which cannot handle the conversion to pkg-util style.

Environment variables to set in the pip subprocess. Can be used to set common variables such as http_proxy, https_proxy and no_proxy Note that pip is run with "--isolated" on the CLI so PIP__ style env vars are ignored, but env vars that control requests and urllib3 can be passed.

Extra arguments to pass on to pip. Must not contain spaces.

Whether or not to pass the --isolated flag to the underlying pip command. Alternatively, the RULES_PYTHON_PIP_ISOLATED enviornment varaible can be used to control this flag.

Additional data exclusion parameters to add to the pip packages BUILD file.

The python interpreter to use. This can either be an absolute path or the name of a binary found on the host's PATH environment variable. If no value is set python3 is defaulted for Unix systems and python.exe for Windows.

If you are using a custom python interpreter built by another repository rule, use this attribute to specify its BUILD target. This allows pip_repository to invoke pip using the same interpreter as your toolchain. If set, takes precedence over python_interpreter.

If True, suppress printing stdout and stderr output to the terminal.

A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.

For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target).

Prefix for the generated packages will be of the form

@//...

Override the requirements_lock attribute when the host platform is Mac OS

Override the requirements_lock attribute when the host platform is Linux

A fully resolved 'requirements.txt' pip requirement file containing the transitive set of your dependencies. If this file is passed instead of 'requirements' no resolve will take place and pip_repository will create individual repositories for each of your dependencies so that wheels are fetched/built only for the targets specified by 'build/run/test'.

Override the requirements_lock attribute when the host platform is Windows

Timeout (in seconds) on the rule's execution duration.

Download and extracts a single wheel based into a bazel repo based on the requirement string passed in. Instantiated from pip_repository and inherits config options from there.

A unique name for this repository.

Optional json encoded file containing annotation to apply to the extracted wheel. See package_annotation

Whether to use "pip download" instead of "pip wheel". Disables building wheels from source, but allows use of --platform, --python-version, --implementation, and --abi in --extra_pip_args to download wheels for a different platform from the host platform.

If true, disables conversion of native namespace packages into pkg-util style namespace packages. When set all py_binary and py_test targets must specify either legacy_create_init=False or the global Bazel option --incompatible_default_to_explicit_init_py to prevent __init__.py being automatically generated in every directory.

This option is required to support some packages which cannot handle the conversion to pkg-util style.

Environment variables to set in the pip subprocess. Can be used to set common variables such as http_proxy, https_proxy and no_proxy Note that pip is run with "--isolated" on the CLI so PIP__ style env vars are ignored, but env vars that control requests and urllib3 can be passed.

Extra arguments to pass on to pip. Must not contain spaces.

Whether or not to pass the --isolated flag to the underlying pip command. Alternatively, the RULES_PYTHON_PIP_ISOLATED enviornment varaible can be used to control this flag.

Additional data exclusion parameters to add to the pip packages BUILD file.

The python interpreter to use. This can either be an absolute path or the name of a binary found on the host's PATH environment variable. If no value is set python3 is defaulted for Unix systems and python.exe for Windows.

If you are using a custom python interpreter built by another repository rule, use this attribute to specify its BUILD target. This allows pip_repository to invoke pip using the same interpreter as your toolchain. If set, takes precedence over python_interpreter.

If True, suppress printing stdout and stderr output to the terminal.

Pointer to parent repo name. Used to make these rules rerun if the parent repo changes.

A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.

For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target).

Prefix for the generated packages will be of the form

@//...

Python requirement string describing the package to make available

Timeout (in seconds) on the rule's execution duration.

Get the preferred label for a locked requirements file based on platform.

repository or module context

attributes for the repo rule or tag extension

Annotations to apply to the BUILD file content from package generated from a pip_repository rule.

Raw text to add to the generated BUILD file of a package.

A mapping of src and out files for [@bazel_skylib//rules:copy_file.bzl][cf]

A mapping of src and out files for [@bazel_skylib//rules:copy_file.bzl][cf]. Targets generated here will also be flagged as executable.

A list of labels to add as data dependencies to the generated py_library target.

A list of exclude glob patterns to add as data to the generated py_library target.

A list of labels to add as srcs to the generated py_library target.

Determine whether or not to pass the pip --isolated flag to the pip invocation.

repository or module context

attributes for the repo rule or tag extension