To use the Pulse Python API, you must build Pulse and enable the Pulse_PYTHON_API option. We hope to have Python Package Index (PyPI) support in the future.
Once Pulse is built with Python support, an easy way to get started with the Pulse Python API is to use the PyCharm IDE.
Open The Pulse Project In PyCharm
From the initial PyCharm splash screen, choose the Open option.
Navigate to your Pulse source code folder and select the src/python folder.
Add Pulse to your PYTHONPATH
From the File menu option, select Settings
Navigate to the Project:python option and select Project Interpreter
Ensure you have a Python interpreter selected (one of version >= 3.8 is suggested)
Click on the Python Interpreter drop-down, and select Show All... . Select the Show Interpreter Paths icon.
Add the path to your Pulse build\install\bin as well as the build\Innerbuild\src\python directory.
Select the many OK buttons to close out all settings windows.
Next, from the Run menu option, select the Edit Configurations... option. Select Edit configuration templates....
Select the Python and set the Working directory field to your Pulse build install/bin folder and hit OK .
Now you can right-click any How-To files and Debug/Run them!
Create your own Python files or modify ours, and let us know if you have any issues in our discourse forum!