gen_mqtt_service

Generate MQTT service

Project maintained by vroncevic Hosted on GitHub Pages — Theme by mattgraham

Create MqttService project skeleton

gen_mqtt_service is tool for creating MqttService project skeleton.

Developed in python code.

The README is used to introduce the tool and provide instructions on how to install the tool, any machine dependencies it may have and any other information that should be provided before the tool is installed.

Table of Contents

🚀 Installation
📦 Dependencies
📁 Tool structure
- ✨ Features
📊 Code coverage
🛠 Usage
📚 Docs
👥 Contributing
📄 Copyright and licence

🚀 Installation

Used next development environment

debian linux os

Currently there are four ways to install package

Install process based on using pip mechanism
Install process based on build mechanism
Install process based on setup.py mechanism
Install process based on docker mechanism

Install using pip

gen_mqtt_service is located at pypi.org.

You can install by using pip

# python3
pip3 install gen_mqtt_service

Install using build

Navigate to release page download and extract release archive.

To install gen_mqtt_service type the following

tar xvzf gen_mqtt_service-x.y.z.tar.gz
cd gen_mqtt_service-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py 
# python3
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/gen_mqtt_service-*-py3-none-any.whl
rm -f get-pip.py

Install using py setup

Navigate to release page download and extract release archive.

To install gen_mqtt_service locate and run setup.py with arguments

tar xvzf gen_mqtt_service-x.y.z.tar.gz
cd gen_mqtt_service-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info

Install using docker

You can use Dockerfile to create image/container.

📦 Dependencies

gen_mqtt_service requires next modules and libraries

ats-utilities - Python App/Tool/Script Utilities

📁 Tool structure

gen_mqtt_service is based on OOP.

Tool structure

Click to expand framework structure

```bash gen_mqtt_service/ ├── core/ │ ├── __init__.py │ ├── model/ │ │ ├── __init__.py │ │ └── project_setup.py │ └── service/ │ ├── engine.py │ ├── __init__.py │ ├── iservice.py │ └── isubprocessor.py ├── engine.py ├── infrastructure/ │ ├── cli/ │ │ ├── engine.py │ │ ├── icli.py │ │ ├── __init__.py │ │ └── setup/ │ │ ├── bundle.py │ │ ├── dep_validator.py │ │ ├── dependencies.py │ │ ├── factory.py │ │ ├── __init__.py │ │ ├── keys.py │ │ ├── opt_validator.py │ │ ├── options.py │ │ ├── registry.py │ │ └── validator.py │ ├── command/ │ │ ├── command.py │ │ ├── gen_mqtt_service_command_definition.py │ │ ├── gen_mqtt_service_command_executor.py │ │ ├── icommand_definition.py │ │ ├── icommand_executor.py │ │ └── __init__.py │ ├── config/ │ │ ├── gen_mqtt_service.cfg │ │ ├── gen_mqtt_service.logo │ │ ├── scheme.json │ │ └── templates.tgz │ └── subprocessor.py ├── __init__.py ├── py.typed └── setup/ ├── bundle.py ├── dep_validator.py ├── dependencies.py ├── factory.py ├── __init__.py ├── keys.py ├── opt_validator.py ├── options.py ├── registry.py └── validator.py 10 directories, 44 files ```

✨ Features

Automatically scaffolds MQTT service publisher/subscriber client skeleton projects.
Multi-language and multi-platform support: Python (paho), C (mosquitto), Node.js (node), and Node.js WebSocket (node_ws).
Granular generation control via --role {subscriber,publisher,both} and --scope {module,demo}.
Engineered with OOP, SOLID principles, and Clean Architecture (PEP 544 structural protocols in Python).
Command line interface (CLI) support via structured command and executor layers.
Robust validation of project bundles, dependencies, and generation parameters.
Configurable compressed templates (templates.tgz) and JSON schema definitions.
Production code quality with 100% test coverage and strict type annotations.

📊 Code coverage

Click to expand code coverage

| Name | Stmts | Miss | Cover | |------|-------|------|-------| | `gen_mqtt_service/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/core/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/core/model/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/core/model/project_setup.py` | 19 | 0 | 100%| | `gen_mqtt_service/core/service/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/core/service/engine.py` | 27 | 0 | 100%| | `gen_mqtt_service/core/service/iservice.py` | 14 | 0 | 100%| | `gen_mqtt_service/core/service/isubprocessor.py` | 14 | 0 | 100%| | `gen_mqtt_service/engine.py` | 57 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/engine.py` | 39 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/icli.py` | 14 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/bundle.py` | 22 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/dep_validator.py` | 36 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/dependencies.py` | 18 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/factory.py` | 35 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/keys.py` | 26 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/opt_validator.py` | 36 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/options.py` | 15 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/registry.py` | 24 | 0 | 100%| | `gen_mqtt_service/infrastructure/cli/setup/validator.py` | 43 | 0 | 100%| | `gen_mqtt_service/infrastructure/command/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/infrastructure/command/command.py` | 16 | 0 | 100%| | `gen_mqtt_service/infrastructure/command/gen_mqtt_service_command_definition.py` | 24 | 0 | 100%| | `gen_mqtt_service/infrastructure/command/gen_mqtt_service_command_executor.py` | 29 | 0 | 100%| | `gen_mqtt_service/infrastructure/command/icommand_definition.py` | 14 | 0 | 100%| | `gen_mqtt_service/infrastructure/command/icommand_executor.py` | 14 | 0 | 100%| | `gen_mqtt_service/infrastructure/subprocessor.py` | 77 | 0 | 100%| | `gen_mqtt_service/setup/__init__.py` | 9 | 0 | 100%| | `gen_mqtt_service/setup/bundle.py` | 23 | 0 | 100%| | `gen_mqtt_service/setup/dep_validator.py` | 36 | 0 | 100%| | `gen_mqtt_service/setup/dependencies.py` | 19 | 0 | 100%| | `gen_mqtt_service/setup/factory.py` | 49 | 0 | 100%| | `gen_mqtt_service/setup/keys.py` | 27 | 0 | 100%| | `gen_mqtt_service/setup/opt_validator.py` | 34 | 0 | 100%| | `gen_mqtt_service/setup/options.py` | 12 | 0 | 100%| | `gen_mqtt_service/setup/registry.py` | 32 | 0 | 100%| | `gen_mqtt_service/setup/validator.py` | 48 | 0 | 100%| | **Total** | 965 | 0 | 100% |

🛠 Usage

Install package

pip3 install gen_mqtt_service

Prepare main entry point by downloading main.py or create your own.

wget -O main.py https://raw.githubusercontent.com/vroncevic/gen_mqtt_service/main/main.py

Running tool for creating new MqttService project skeleton:

# Python Paho complete demo (both publisher & subscriber)
python3 main.py create --name mytool --type paho --output ./demo/

# Python Paho publisher module only (for embedding in existing services)
python3 main.py create --name mypub --type paho --role publisher --scope module --output ./services/

# C Mosquitto subscriber demo
python3 main.py create --name myclient --type mosquitto --role subscriber --scope demo --output ./demo/

# Node.js standard MQTT demo
python3 main.py create --name node_mqtt --type node --role both --scope demo --output ./demo/

# Node.js WebSocket MQTT with embedded Aedes broker
python3 main.py create --name node_ws_svc --type node_ws --role both --scope demo --output ./demo/

For complete architecture details, design patterns, and instructions for building and running each template, see the Templates Architecture & Usage Guide.

📚 Docs

👥 Contributing

Contributing to gen_mqtt_service

📄 Copyright and licence

gen_mqtt_service is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 3.x or, at your option, any later version of Python 3 you may have available.

Lets help and support PSF.