View a markdown version of this page

Pip queue environment for Deadline Cloud - Deadline Cloud

Pip queue environment for Deadline Cloud

The pip_queue_env.yaml queue environment provides Python packages to jobs using pip and the standard library venv module, rather than a package manager such as conda or Rez. For more information about the queue environment, see pip_queue_env.yaml on the GitHub website. For more information about pip, see pip on the pip website. For more information about venv, see venv on the Python website.

When a job provides a PipPackages parameter value, the queue environment creates a Python virtual environment in the session working directory, installs the requested packages into it with pip, and activates it so that the job's steps run with those packages available. If PipPackages is empty, the queue environment does nothing, so you can add it to a queue that also runs jobs that don't use it.

The PipIndexUrl and PipExtraIndexUrls parameters let jobs install from a private package index, such as an AWS CodeArtifact repository, instead of the default PyPI index on the PyPI website.

Unlike conda and Rez, pip and venv are included with Python itself, so worker hosts only need a python3 (or python) interpreter on the PATH. Deadline Cloud service-managed fleets provide one.

The pip_package_job job bundle on the GitHub website shows how to submit a job that uses this queue environment. For a job bundle that defines the same pip environment inline without a queue environment, see pip_self_contained_job on the GitHub website.