install

omni.kit.pipapi.pipapi.install(package: str, module: str = None, ignore_import_check: bool = False, ignore_cache: bool = False, version: str = None, use_online_index: bool = True, surpress_output: bool = False, extra_args: List[str] = None) → bool

Install pacakage using pip into user specified env path. Install calls for particular package name persistently cache to avoid overhead for future calls when package is already installed. Cache is stored in the `.install_cache.json` file in the user specified env path folder.

Parameters

• package (str) – Package name to install. It is basically a command to pip install, it can include version and other flags.

• module (str) – Module name to import, by default module assumed to be equal to package.

• ignore_import_check (bool, optional) – If ``True`` ignore attempt to import module and call to ``pip`` anyway - can be slow.

• ignore_cache (bool, optional) – If ``True`` ignore caching and call to ``pip`` anyway - can be slow.

• version (str, optional) – Package version.

• use_online_index (bool, optional) – If ``True`` and package can’t be found in any of archive directories try to use default pip index.

• surpress_output (bool, optional) – If ``True`` pip process output to stdout and stderr will be surpressed, as well as warning when install failed.

• extra_args (List[str], optional) – a list of extra arguments to pass to the Pip process

Returns

``True`` if installation was successfull.