Currently, to use the Pulse Python API, you must build Pulse and enable the Pulse_PYTHON_API option. We hope to have pyip support is the future.
Once Pulse is built with Python support, the easiest way to get started with the Pulse Python API is to use PyCharm.
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 the Pulse to your PYTHONPATH
File menu option, select
Navigate to the
Project:python option and select
Ensure you have a Python interpreter selected ( one of version >= 3.6 is suggested)
Click on the
Cog Icon to the right of the selected interpreter drop down, and select
Next, click on the bottom icon (Folder hierarchy) of the vertically arranged buttons.
The tooltip of the button is
Show paths for the selected interpreter
Add the path to your Pulse build install\bin directory
And click the many
OK buttons to close out all settings windows.
Next, From the
Run menu option, select the
Edit Configurations... option
Python option under
Templates and set the
Working directory field to your Pulse build install/bin folder, and hit
Now you can right-click any of the How-To files and Debug/Run them!
Create your own python files or modify ours, and let us know if you have any issues on our discourse forum!