Python SDK

Prerequisites

• Compatible system
• Python 3.1 minimum. 3.10 or newer recommended
• A valid Pixyz SDK license on your Pixyz license portal

Setup

Setup using pip (recommended)

1. Run

   pip install pxz --extra-index-url https://unity3ddist.jfrog.io/artifactory/api/pypi/pixyz-pypi-prod-local/simple

2. Setup your license
3. Run your first script

SDK without UI frontend

1. Run

   pip install pxz --no-deps --extra-index-url https://unity3ddist.jfrog.io/artifactory/api/pypi/pixyz-pypi-prod-local/simple

2. Setup your license
3. Run your first script

https://unity3ddist.jfrog.io/artifactory/api/pypi/pixyz-pypi-prod-local/simple

WARNING: The scripts PiXYZFinishInstall.exe, PiXYZGenerateActivationCode.exe and PiXYZInstallLicense.exe are installed in [...] which is not on PATH

Setup without pip

PyCharm

1. Download SDK from archive
2. Open project
3. Locate your Pixyz SDK binaries folder on your machine or local dev environement
4. Add Pixyz binaries folder to your interpreter path (check PyCharm documentation)

5. Setup your license server
6. Run your first script

Visual Studio Code

1. Download SDK from archive
2. Open project
3. Create a Python environment
4. Set

   PYTHONPATH

   to the Pixyz binaries folder path (by adding an .env file to the project for example)
5. Setup your license
6. Run your first script

Run your first script

Python
import pxzfrom pxz import core# init Pixyzpxz.initialize()# print Pixyz versionprint(core.getVersion())# set log level to INFO so you can see the logs in the consolecore.configureInterfaceLogger(True, True, True)core.addConsoleVerbose(core.Verbose.INFO)# if no license is found, try to configure a license serverif not core.checkLicense():    core.configureLicenseServer("company-server-hostname", 27000, True)# use io.importScene to import a file and enjoy :)