Binaries or from source

The Cyclone DDS Python API requires Python version 3.7 or higher (with 3.11 support provisional).

At runtime, there are several mechanisms to locate the appropriate library for the platform. If you get an exception about non-locatable libraries, or need to manage multiple Cyclone DDS installations, override the load location by setting the CYCLONEDDS_HOME environment variable.

Installing from PyPi

The wheels (binary archives) on PyPi contain a pre-built binary of the CycloneDDS C library and IDL compiler. However, the pre-built package:

• does not provide support for DDS Security,

• does not provide support for shared memory via Eclipse iceoryx,

• comes with generic binaries that are not optimized per platform.

If you need these features, or cannot use the binaries for other reasons, install the Cyclone DDS Python API from source (see below). If the Cyclone DDS C library is not on the PATH, set the environment variable CYCLONEDDS_HOME.

Install Cyclone DDS using pip directly from PyPi.

pip install cyclonedds

Installing from source

Install Cyclone DDS directly from the GitHub link:

CYCLONEDDS_HOME="<cyclonedds-install-location>" pip install git+https://github.com/eclipse-cyclonedds/cyclonedds-python