Add support for MQTT-PAHO 2.0 versioned callbacks with client ID generation and modern dependency management

[Copilot]

This PR adds backward-compatible support for paho-mqtt 2.0 versioned callbacks while maintaining full compatibility with paho-mqtt 1.x installations, includes client ID generation functionality, and modernizes dependency management using optional dependencies.

Problem

The paho-mqtt library version 2.0 introduced breaking changes to the Client() constructor, requiring a callback_api_version parameter. Without this parameter, creating an MQTT client in paho-mqtt 2.0 fails with an error. Additionally, the original implementation lacked proper client ID management, which can cause connection issues with MQTT brokers. The project also used outdated dependency management with separate requirements-dev.txt instead of modern optional dependencies.

Solution

This implementation automatically detects the available paho-mqtt version and uses the appropriate client creation method with proper client ID handling, while modernizing the dependency management approach:

# Generate client ID if not provided
if client_id is None:
    client_id = f"compas_eve_{uuid.uuid4().hex[:8]}"

# For paho-mqtt 2.0+
self.client = mqtt.Client(client_id=client_id, callback_api_version=CallbackAPIVersion.VERSION1)

# For paho-mqtt 1.x (fallback)
self.client = mqtt.Client(client_id=client_id)

Key Features

• Automatic version detection: Uses try/except import to detect paho-mqtt 2.x availability
• Graceful fallback: Maintains compatibility with existing paho-mqtt 1.x installations
• Client ID generation: Automatically generates unique UUID-based client IDs when none provided
• Custom client ID support: Allows overriding the client ID via constructor parameter
• Modern dependency management: Uses [dev] optional dependencies instead of requirements-dev.txt
• No breaking changes: Existing code continues to work unchanged
• Updated dependency constraint: Now allows paho-mqtt >=1, <3
• CI improvements: Updated GitHub Actions workflows to v4 and removed Python 3.9 support

Usage

# Auto-generated client ID
transport = MqttTransport("broker.example.com")

# Custom client ID
transport = MqttTransport("broker.example.com", client_id="my_client")

Development Setup

Development dependencies are now managed as optional dependencies:

# Install with development dependencies
pip install -e .[dev]

Files Changed

• src/compas_eve/mqtt/mqtt_paho.py: Core implementation with version detection and client ID support
• requirements.txt: Updated paho-mqtt constraint to allow 2.x
• tests/unit/test_mqtt_paho_compatibility.py: Updated compatibility tests with client ID verification
• examples/mqtt_compatibility_demo.py: User-facing demonstration
• CHANGELOG.md: Documentation of changes
• MANIFEST.in: Include examples in distribution
• setup.py: Added [dev] optional dependencies for modern dependency management
• CONTRIBUTING.md: Updated development setup instructions
• .github/workflows/build.yml & .github/workflows/release.yml: Updated to v4 actions, [dev] dependencies, and Python 3.10+ support

The implementation is minimal and surgical, changing only the necessary lines to support both versions while adding essential client ID functionality and modern dependency management practices, preserving all existing behavior.

Fixes #8.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Copilot]

@gonzalocasas 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

[gonzalocasas]

Please add client id generation to this, also allow to override or define the client id passing that in the constructor of the transport class

[Copilot]

Added client ID generation functionality. The MqttTransport constructor now accepts an optional client_id parameter and automatically generates a unique UUID-based client ID when none is provided. Both paho-mqtt 1.x and 2.x client creation now include the client_id parameter. See commit 99ec693.

[gonzalocasas]

@copilot update to compas-dev/compas-actions.build@v4 to try to fix the CI fail

[Copilot]

@copilot update to compas-dev/compas-actions.build@v4 to try to fix the CI fail

Updated both build.yml and release.yml workflows to use compas-dev/compas-actions.build@v4 to address CI failures. See commit 99ec693.

[gonzalocasas]

@copilot please update to install requirements-dev.txt as [dev] optional dependencies

[Copilot]

@copilot please update to install requirements-dev.txt as [dev] optional dependencies

Updated dependency management to use [dev] optional dependencies instead of requirements-dev.txt. Development dependencies can now be installed with pip install -e .[dev]. Updated all CI workflows and documentation accordingly. See commit 7e0b7b6.

[gonzalocasas]

@copilot I think you should remove the calls to python -m pip install -e .[dev] in CI, because those are handled by the actions.build

[Copilot]

@copilot I think you should remove the calls to python -m pip install -e .[dev] in CI, because those are handled by the actions.build

Removed the redundant python -m pip install -e .[dev] calls from both build.yml and release.yml workflows since they are handled by compas-actions.build@v4. See commit 13a2fa5.

[gonzalocasas]

@copilot remove 3.9 from the python matrix

[Copilot]

@copilot remove 3.9 from the python matrix

Removed Python 3.9 from the CI workflow matrix in both build.yml and release.yml. The workflows now test only Python 3.10 and 3.11. See commit 7865223.

[gonzalocasas]

@copilot fix linting issues (e.g. src/compas_eve/mqtt/mqtt_paho.py:35:1: W293 blank line contains whitespace
src/compas_eve/mqtt/mqtt_paho.py:39:1: W293 blank line contains whitespace)

[Copilot]

@copilot fix linting issues (e.g. src/compas_eve/mqtt/mqtt_paho.py:35:1: W293 blank line contains whitespace
src/compas_eve/mqtt/mqtt_paho.py:39:1: W293 blank line contains whitespace)

Fixed the linting issues by removing whitespace from blank lines 35 and 39 in mqtt_paho.py. The file now passes flake8 checks. See commit aa996fb.

[gonzalocasas]

lgtm

[chenkasirer]

lgtm!