Supported Environments for the PubSub+ Python API

The PubSub+ Python API is compatible and supported with any version of Python that is in active support and also has security update support. For information about the supported versions of Python, see the Python.org website.

The PubSub+ Python API is compatible with the following systems:

  • Windows (32-bit and 64-bit versions) that are in active support and also have security update support.
  • Linux (x86/x86_64) variants that are in active support and also have security update support, running either:
    • glibc version 2.17 or later (desktop/server only), which includes Debian-based (e.g., Ubuntu) and CentOS/RHEL-based (e.g., Red Hat Linux, CentOS) distributions.
    • musl-c version 1.2 or later (Alpine Linux).
  • Linux (ARM) variants that are in active support and also have security update support, running:
    • glibc version 2.17 or later (desktop/server only), which includes Debian-based (e.g., Ubuntu) and CentOS/RHEL-based (e.g., Red Hat Linux, CentOS) distributions.
  • macOS [x86_64 versions and ARM (M-Series processors)] that are in active support and also have security update support.

Installing the PubSub+ Python API

You can retrieve PubSub+ Python API from solace-pubsubplus. Alternatively, you can install the PubSub+ Python API with pip by using the following command in your project directory:

pip install solace-pubsubplus

The command above retrieves and installs the latest version of the PubSub+ Messaging API for Python.

OpenSSL Compatibility

The PubSub+ Python API is compatible with OpenSSL 3.0 and OpenSSL 1.1. The PubSub+ Python API bundles OpenSSL libraries for developer convenience only; these libraries are unsuitable for production environments. OpenSSL binaries are bundled with the following:

  • for macOS and Windows, all versions of the PubSub+ Python API
  • for Linux, versions 1.7 and earlier of the PubSub+ Python API

OpenSSL is required for encrypted (TLS) connections to PubSub+ event brokers. For production environments, we recommend you install OpenSSL directly to ensure that you have the most recent version. To install OpenSSL:

  • Use your preferred package manager for Python.
  • Download, build, and install OpenSSL from www.openssl.org.

TLS and SSL Support

Transport Layer Security (TLS) provides secure connections between PubSub+ Python APIs and event brokers. The PubSub+ Python API supports the following TLS versions. The recommended version to use is the most recent version of TLS:

The PubSub+ Python API now supports TLS 1.3 connections when connecting to event brokers that request TLS 1.3, allowing you to prepare your client applications in advance. Full end-to-end testing capabilities will be enabled with the upcoming event broker release 10.25.0, planned for June 2025. For more information, see Event Broker Releases. After 10.25.0 is available, you can then perform end-to-end testing and deployment of TLS 1.3.

  • TLS 1.2
  • TLS 1.3—Requires PubSub+ Python API, version 1.10 or later .

In this documentation, the term TLS/SSL refers to Transport Layer Security (TLS) and Secure Sockets Layer (SSL) protocols used for securing data transmission. We don't recommend that you use SSL unless it's required for backwards compatibility.

Using an Integrated Development Environment

If you are using an Integrated Development Environment (IDE), such as PyCharm, integrated help is available, provided you have Docstrings rendered as reStructuredText. In some IDEs, you configure this in the settings. For example, in PyCharm, you go to File > Settings >Tool > Python Integrated Tools, select reStructureText in the Docstring format list, and click Apply.

Screenshot showing an example as described by the surrounding text.