omni.kit.pipapi ########################### Module to enable usage of ``pip install`` in Omniverse Kit environment. It wraps ``pip install`` calls and reroutes package installation into user specified environment folder. It also extends Kit Extension System by enabling extensions to depend on python packages and providing pip archive folders for offline pip install (prebundling). Extension Config ****************** All extensions that loaded after **omni.kit.pipapi** can specify those additional configuration settings in their extension.toml file: extension.toml ---------------- .. code:: toml [python.pipapi] # List of additional directories with pip achives to be passed into pip using ``--find-links`` arg. # Relative paths are relative to extension root. Tokens can be used. archiveDirs = ["path/to/pip_archive"] # Commands passed to pip install before extension gets enabled. Can also contain flags, like `--upgrade`, `--no--index`, etc. # Refer to: https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format requirements = [ "simplejson=6.1", "numpy" ] # Allow going to online index if package can't be found locally (not recommended) use_online_index = false # Use this to specify a list of additional repositories if your pip package is hosted somewhere other # than the default repo(s) configured in pip. Will pass these to pip with "--extra-index-url" argument repositories = ["https://my.additional.pip_repo.com/"] That means that extensions can either: 1. Depend on other pip packages 2. Bring wheels (bundle) pip packages for others to use. Or both. API Reference *************** .. automodule:: omni.kit.pipapi :platform: Windows-x86_64, Linux-x86_64 :members: :undoc-members: :imported-members: :exclude-members: contextmanager, Path, lru_cache, ExtensionManagerPip