rez.package_bind

rez.package_bind.bind_package(name, path=None, version_range=None, no_deps=False, bind_args=None, quiet=False)[source]

Bind software available on the current system, as a rez package.

Note

bind_args is provided when software is bound via the ‘rez-bind’ command line tool. Bind modules can define their own command line options, and they will be present in bind_args if applicable.

Parameters
  • name (str) – Package name.

  • path (str) – Package path to install into; local packages path if None.

  • version_range (VersionRange) – If provided, only bind the software if it falls within this version range.

  • no_deps (bool) – If True, don’t bind dependencies.

  • bind_args (list of str) – Command line options.

  • quiet (bool) – If True, suppress superfluous output.

Returns

The variant(s) that were installed as a result of binding this package.

Return type

List of Variant

rez.package_bind.find_bind_module(name, verbose=False)[source]

Find the bind module matching the given name.

Parameters
  • name (str) – Name of package to find bind module for.

  • verbose (bool) – If True, print extra output.

Returns

Filepath to bind module .py file, or None if not found.

Return type

str

rez.package_bind.get_bind_modules(verbose=False)[source]

Get available bind modules.

Returns

Map of (name, filepath) listing all bind modules.

Return type

dict