Metadata-Version: 2.4
Name: gen_mqtt_service
Version: 1.1.4
Summary: Generating MQTT modules
Home-page: https://vroncevic.github.io/gen_mqtt_service
Author: Vladimir Roncevic
Author-email: elektron.ronca@gmail.com
License: GPL-3.0-or-later
Keywords: Unix,Linux,Development,MQTT,Modules
Platform: POSIX
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ats-utilities
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

# Generate MQTT Service

<img align="right" src="https://raw.githubusercontent.com/vroncevic/gen_mqtt_service/dev/docs/gen_mqtt_service_logo.png" width="25%">

**gen_mqtt_service** is toolset for generation of MQTT service.

Developed in **[python](https://www.python.org/)** code: **100%**.

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

[![gen_mqtt_service python checker](https://github.com/vroncevic/gen_mqtt_service/actions/workflows/gen_mqtt_service_python_checker.yml/badge.svg)](https://github.com/vroncevic/gen_mqtt_service/actions/workflows/gen_mqtt_service_python_checker.yml) [![gen_mqtt_service package checker](https://github.com/vroncevic/gen_mqtt_service/actions/workflows/gen_mqtt_service_package_checker.yml/badge.svg)](https://github.com/vroncevic/gen_mqtt_service/actions/workflows/gen_mqtt_service_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_mqtt_service.svg)](https://github.com/vroncevic/gen_mqtt_service/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_mqtt_service.svg)](https://github.com/vroncevic/gen_mqtt_service/graphs/contributors)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Installation](#installation)
    - [Install using pip](#install-using-pip)
    - [Install using build](#install-using-build)
    - [Install using py setup](#install-using-py-setup)
    - [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Code coverage](#code-coverage)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and licence](#copyright-and-licence)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

### Installation

![debian linux os](https://raw.githubusercontent.com/vroncevic/gen_mqtt_service/dev/docs/debtux.png)

[![gen_mqtt_service python3 build](https://github.com/vroncevic/gen_mqtt_service/actions/workflows/gen_mqtt_service_python3_build.yml/badge.svg)](https://github.com/vroncevic/gen_mqtt_service/actions/workflows/gen_mqtt_service_python3_build.yml)

Currently there are three 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

Python package is located at **[pypi.org](https://pypi.org/project/gen-mqtt-service/)**.

You can install by using pip

```bash
# python3
pip3 install gen-mqtt-service
```

##### Install using build

Navigate to release **[page](https://github.com/vroncevic/gen_mqtt_service/releases/)** download and extract release archive.

To install **gen_mqtt_service** type the following

```bash
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 -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
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_mqtt_service_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_mqtt_service_run.py /usr/local/bin/gen_mqtt_service_run.py
```

##### Install using py setup

Navigate to release **[page](https://github.com/vroncevic/gen_mqtt_service/releases/)** download and extract release archive.

To install modules, locate and run setup.py with arguments

```bash
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_data
python3 setup.py install_egg_info
```

##### Install using docker

You can use docker to create image/container.

### Dependencies

**gen_mqtt_service** requires next modules and libraries

* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/ats_utilities)

### Tool structure

**gen_mqtt_service** is based on OOP.

Generator structure

```bash
    gen_mqtt_service/
            ├── conf/
            │   ├── gen_mqtt_service.cfg
            │   ├── gen_mqtt_service.logo
            │   ├── gen_mqtt_service_util.cfg
            │   ├── project.yaml
            │   └── template/
            │       ├── mosquitto/
            │       │   ├── publisher.template
            │       │   └── subscriber.template
            │       ├── node/
            │       │   ├── publisher.template
            │       │   └── subscriber.template
            │       ├── node_ws/
            │       │   ├── client.template
            │       │   └── server.template
            │       └── paho/
            │           ├── publisher.template
            │           └── subscriber.template
            ├── __init__.py
            ├── log/
            │   └── gen_mqtt_service.log
            ├── pro/
            │   ├── __init__.py
            │   ├── read_template.py
            │   └── write_template.py
            └── run/
                └── gen_mqtt_service_run.py

        10 directories, 18 files
```

### Code coverage

| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_mqtt_service/__init__.py` | 73 | 12 | 84%|
| `gen_mqtt_service/pro/__init__.py` | 60 | 0 | 100%|
| `gen_mqtt_service/pro/read_template.py` | 56 | 6 | 89%|
| `gen_mqtt_service/pro/write_template.py` | 52 | 2 | 96%|
| **Total** | 241 | 20 | 92% |

### Docs

[![Documentation Status](https://readthedocs.org/projects/gen_mqtt_service/badge/?version=latest)](https://gen-mqtt-service.readthedocs.io/en/latest/?badge=latest)

More documentation and info at

* [gen_mqtt_service.readthedocs.io](https://gen-mqtt-service.readthedocs.io)
* [www.python.org](https://www.python.org/)

### Contributing

[Contributing to gen_mqtt_service](CONTRIBUTING.md)

### Copyright and Licence

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Copyright (C) 2020 - 2026 by [vroncevic.github.io/gen_mqtt_service](https://vroncevic.github.io/gen_mqtt_service)

**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.

[![Python Software Foundation](https://raw.githubusercontent.com/vroncevic/gen_mqtt_service/dev/docs/psf-logo-alpha.png)](https://www.python.org/psf/)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.python.org/psf/donations/)
