winIDEA SDK
Loading...
Searching...
No Matches
Python

Overview

The winIDEA SDK is available in several languages. The most popular choice is Python. This page explains how to obtain and install the Python SDK.

Installation

The winIDEA SDK for Python is installed with Python's pip package installer. There are two ways of obtaining the package.

Install from PyPi (recommended)

The winIDEA SDK for Python is also available on PyPi as the isystem.connect package. Install it with:

python -m pip install isystem.connect

To upgrade an already installed SDK to the latest version, execute:

python -m pip install --upgrade isystem.connect

To see the version of the installed winIDEA SDK, execute the following code:

import isystem.connect as ic
print(ic.getModuleVersion())

Download from web page

The winIDEA SDK download page offers the winIDEA SDK zip file for Python. Download it and extract it. It contains Python wheel installers, which can be installed in a similar than the packages obtained from PyPI server:

python -m pip install isystem_connect-9.26.11.2.316513-cp314-none-win_amd64.whl

Documentation

By default, we recommend users to use the online winIDEA SDK documentation, which is regularly updated with latest examples and best practices. If you need the access to the documentation without web access, the copy of the documentation is provided in the documentation directory in the downloaded winIDEA SDK archive.

iTest

The itest directory contains supporting materials for isystem.test, which is the unit and system test automation library.

Examples

The examples directory contains example scripts runnable from winIDEA or command line, same as they are listed in the Python Examples by Group chapter.