Rules for creating conda environments in Bazel 💚
For more info see the docs or the example.
rules_conda
don't have any strict requirements by themselves.
Just make sure you are able to use conda
.
Add this to your WORKSPACE
file and put appropriate values taken from chosen release:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_conda",
sha256 = "...", # copy from release
url = "...", # copy from release
)
load("@rules_conda//:defs.bzl", "conda_create", "load_conda", "register_toolchain")
load_conda(quiet = False)
conda_create(
name = "env",
environment = "@//:environment.yml",
quiet = False,
)
register_toolchain(env = "env")
After that, all Python targets will use the environment specified in register_toolchain
.
See below for more advanced example.
This example shows all possibilities of rules_conda
:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_conda",
sha256 = "...", # copy from release
url = "...", # copy from release
)
load("@rules_conda//:defs.bzl", "conda_create", "load_conda", "register_toolchain")
load_conda(
conda_version = "4.10.3", # version of conda to download, default is 4.10.3
installer = "miniforge", # which conda installer to download, either miniconda or miniforge, default is miniconda
install_mamba = True, # whether to install mamba, which is a faster drop-in replacement for conda, default is False
mamba_version = "0.17.0", # version of mamba to install, default is 0.17.0
quiet = False, # True if conda output should be hidden, default is True
timeout = 600, # how many seconds each execute action can take, default is 3600
)
conda_create(
name = "env", # name of the environment
environment = "@//:environment.yml", # label pointing to environment configuration file
use_mamba = True, # Whether to use mamba to create the conda environment. If this is True, install_mamba must also be True
clean = False, # True if conda cache should be cleaned (less space taken, but slower subsequent builds), default is False
quiet = False, # True if conda output should be hidden True, default is True
timeout = 600, # how many seconds each execute action can take, default is 3600
)
register_toolchain(env = "env")
These rules allow you to download and install conda
, create conda
environments and register Python toolchain from environments.
This means you can achieve truly reproducible and hermetic local Python environments.
Only Python 3 is supported.
Pros:
conda
installation necessaryconda
installation, no global PATH
modificationsenvironment.yml
Cons:
environment.yml
, the whole environment will be recreated from scratch (but cached package data can be reused)PATH
or set CONDA_DLL_SEARCH_MODIFICATION_ENABLE=1
during runtime, so DLLs can be loaded properly (more on that here)So I think these rules suit you if:
conda
for Python environment management