(kit-python-package-main-doc)=

Kit Python 包

Kit 以Python (PIP, wheel) 包的形式发布。这意味着您可以将 Kit 作为Python库用于您的Python项目中。

它可以在PyPI索引中找到。但它是一个占位符包，要从PyPI安装 Kit，您需要将额外的索引URL传递给pip

pip install omniverse-kit --extra-index-url https://pypi.nvidia.com

入门

python -m venv myenv
myenv\Scripts\activate
pip install omniverse-kit --extra-index-url https://pypi.nvidia.com
python -m omni.kit_app

在这个示例中，我们创建一个新的虚拟环境，激活它，将 Kit 安装为Python包，并运行 Kit。它将以与从 kit.exe 启动相同的方式启动，但使用的是Python。

KitApp 示例

omni.kit_app 模块提供初始引导和 KitApp 类，这是一种以Python方式启动 Kit 的方法。它是对 kit.exe 命令行界面的薄包装，并提供了一种从Python启动 Kit、传递命令行参数给它以及控制基本更新循环的方法

:language: py

在这个示例中，我们启动 Kit，要求它启用 omni.ui 扩展。使用它来构建简单的UI窗口。之后，我们保持应用程序更新循环运行，直到应用程序被指示退出。这只有在启用的扩展中包含 omni.kit.loop（或类似）实现主要更新循环接口（omni::kit::IRunLoopRunner）的情况下才能工作。否则，Kit 将退出。

必须将 from omni.kit_app import KitApp 导入作为 Omniverse 导入的第一项，它设置环境（加载Carbonite，添加库和Python路径）。

通常，扩展程序会订阅更新循环事件（如每帧渲染UI、处理新输入事件等）。然而，对于某些应用程序来说，可能需要完全控制更新循环。为了调用各种扩展程序的显式API，而不是依赖于它们基于事件的API。

:language: py

在这个示例中，我们启动了 Kit，要求它启用 omni.usd 扩展程序。在那之后，扩展程序可用（添加到 sys.path，启动被调用），我们可以在Python代码中使用它。

最终用户许可协议（EULA）

在第一次导入 omni.kit_app 模块时，它会要求您接受EULA。这是一个一次性操作，如果接受，则不会再要求。另一种接受EULA的方法是将环境变量 OMNI_KIT_ACCEPT_EULA 设置为 yes。

可编辑模式

您可以在可编辑模式下安装 Kit Python包，这意味着您可以修改源代码并立即看到更改。这对于开发和调试很有用。

假设您已从源代码构建了 Kit

pip install -e [path to kit source]/_build/packages/python/omniverse-kit