Skip to main content

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

Kit Python Package

Kit is published as a Python (PIP, wheel) package. This means that you can use Kit as a Python library in your Python projects.

It can be found PyPI index. But it is a placeholder package, to install Kit from PyPI you need pass an extra index URL to pip:

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

Getting Started

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

In this example we create a new virtual environment, activate it, install Kit into it as python package, and run Kit. It will start in the same way as if it was started from the kit.exe, but instead your python is used.

KitApp Example

The omni.kit_app module provides an initial bootstrapping and KitApp class, which is a Pythonic way to start Kit. It is a thin wrapper around the kit.exe command line interface, and it provides a way to start Kit from Python, to pass command line arguments to it, to control the basic update loop:

:language: py

In this example we startup Kit asking it to enable omni.ui extension. Use it to build a simple UI window. After that we keep app update loop running until app is signaled to exit. That will only work if among enabled extension is omni.kit.loop (or similar) which implements the main update loop interface (omni::kit::IRunLoopRunner). Otherwise Kit will exit.

The from omni.kit_app import KitApp import must be the first of omniverse imports, it sets up the environment (loads Carbonite, adds library and python paths).

Typically extensions subscribe to update loop events (like render UI every frame, process new input events, etc). However, for some applications it might be useful to have a full control over the update loop. To call explicit API of various extensions, rather than rely on their event-based API:

:language: py

In this example we startup Kit asking it to enable omni.usd extension. After that extension is available (added to sys.path, startup was called) and we can use it in our Python code.

EULA

On the first import of omni.kit_app module, it will ask you to accept the EULA. This is a one-time operation, if accepted, it will not ask again. An alternative way to accept the EULA is to set the environment variable OMNI_KIT_ACCEPT_EULA to yes.

Editable Mode

You can install Kit python package in editable mode, which means that you can modify the source code and see the changes immediately. This is useful for development and debugging.

Assuming you've built Kit from source:

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

Metadata

Release files for omniverse-kit 110.4.1.392751

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for omniverse-kit 110.4.1.392751
File Interpreter ABI Platform Actions
omniverse_kit-110.4.1.392751-cp312-none-win_amd64.whl CPython 3.12 none Windows x86-64 Details for omniverse_kit-110.4.1.392751-cp312-none-win_amd64.whl
omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_x86_64.whl CPython 3.12 none Linux glibc 2.35+ x86-64 Details for omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_x86_64.whl
omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_aarch64.whl CPython 3.12 none Linux glibc 2.35+ ARM64 Details for omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_aarch64.whl

Total release size: 227.5 MB

Release files / omniverse_kit-110.4.1.392751-cp312-none-win_amd64.whl

Download URL omniverse_kit-110.4.1.392751-cp312-none-win_amd64.whl
Size 65.7 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
95e557921c8ccb35cce966a00030c98a9f3cf772b1da7caed7940bce3dd374d3
BLAKE2b-256 checksum
How to use checksums
1702928d32b919371e161beaf8c697de4ef2010228e1ffb4734f40668b8aa4c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Release files / omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_x86_64.whl

Download URL omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_x86_64.whl
Size 76.5 MB
Tags CPython 3.12 Linux glibc 2.35+ x86-64
SHA-256 checksum
How to use checksums
48517b56dbebaa4148ee39a7de3392bd32cd0ca9dc8bb5e037c2240423077b6c
BLAKE2b-256 checksum
How to use checksums
31d2721f9c6e5668b96849449611b703a23bc91989b36c56d8c3d7ca89cffaae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Release files / omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_aarch64.whl

Download URL omniverse_kit-110.4.1.392751-cp312-none-manylinux_2_35_aarch64.whl
Size 85.4 MB
Tags CPython 3.12 Linux glibc 2.35+ ARM64
SHA-256 checksum
How to use checksums
3fb83fd6af53bb47e594c77c7576dbbe33a11d66619068dee59d96495385a9bb
BLAKE2b-256 checksum
How to use checksums
a4bba886e0bd9e13098f4a0ae5d062ef4c2b431b8a82d3e5771b94d2c651ef8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Security for omniverse-kit 110.4.1.392751

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page