Building and Installing

Building connextdds-py

This section describes how to build and install connextdds-py.

Requirements

  • Windows® (requires Visual Studio® 2015 or newer), macOS®, or Linux®

  • Python® 2.7 or Python3.x with pip or pip3 respectively

  • Connext DDS 5.3.1, 6.0.0, or 6.0.1

  • patchelf (Python 2.7.x on Linux)

Note

On certain platforms (such as Ubuntu 20.04 LTS), you must explicitly mention what Python version you are using. To do so, just use pip3 or python3 in place of pip or python.

Configuration

Before building/installing connextdds-py, it is necessary to run the configuration.py script.

$ python configure.py [options...] platform

Where “platform” specifies the RTI target architecture/platform string and the options are specified in the following table.

Short Option

Long Option

Description

-n NDDSHOME

–nddshome NDDSHOME

NDDSHOME directory. Defaults to NDDSHOME environment variable.

-j JOBS

–jobs JOBS

Number of concurrent build jobs/processes

-t

–tcp

Add the TCP transport plugin

-m

–monitoring

Add the RTI Monitoring plugin

-s

–secure

Add the RTI DDS Secure plugin + openssl libraries

-p PLUGIN

–plugin PLUGIN

Add a user-defined plugin. This option can be specified multiple times

-o OPENSSL

–openssl OPENSSL

Location of openssl libraries (defaults to platform library location under NDDSHOME)

-d

–debug

Use debug libraries and build debug modules for connext-py

-h

–help

Show help message and exit

Simple Installation

  1. Clone the repository and submodules, and enter the directory.

$ git clone --recurse-submodules https://github.com/rticommunity/connextdds-py.git
$ cd connextdds-py

  1. Run configuration.py script

$ python configure.py [options...] <platform>

  1. Build and install.

$ pip install .

Simple Wheel Build

  1. Clone the repository and submodules, and enter the directory.

$ git clone --recurse-submodules https://github.com/rticommunity/connextdds-py.git
$ cd connextdds-py

  1. Run configuration.py script

$ python configure.py [options...] <platform>

  1. Build the wheel.

$ pip wheel .

Development Installation

If you want to cache the build files, you can use wheels.

  1. Install the required Python modules:

Windows
$ pip install setuptools wheel cmake
Linux
$ pip install setuptools wheel cmake patchelf-wrapper
macOS
$ pip install setuptools wheel cmake delocate

  1. Clone the repository and submodules, and enter the directory.

$ git clone --recurse-submodules https://github.com/rticommunity/connextdds-py.git
$ cd connextdds-py

  1. Run configuration.py script

$ python configure.py [options...] <platform>

  1. Run the setup script.

$ python setup.py bdist_wheel

  1. Install the package.

$ pip install dist/*

Uninstalling

If you wish to install a new version or update the development version, you must uninstall the Python package. To do so, run:

$ pip uninstall rti -y