franzmq 0.4.0b3__tar.gz

franzmq-0.4.0b3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alpamayo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

franzmq-0.4.0b3/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: franzmq
+Version: 0.4.0b3
+Summary: Typed MQTT client and topic/payload model for ISA-95-ish messaging.
+Author-email: Alpamayo <info@alpamayo-solutions.com>
+License: MIT License
+        
+        Copyright (c) 2025 Alpamayo
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/alpamayo-solutions/franzmq
+Project-URL: Issues, https://github.com/alpamayo-solutions/franzmq/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Internet
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: paho-mqtt>=2.0
+Requires-Dist: python-decouple>=3.8
+Provides-Extra: dev
+Requires-Dist: build>=1.2.1; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Dynamic: license-file
+
+# FranzMQ
+
+**FranzMQ** is a flexible, structured MQTT communication library designed to streamline MQTT messaging for internal and external communication in edge and cloud applications. It builds on top of the `paho-mqtt` client and introduces a typed, hierarchical topic and payload system based on the ISA-95 model.
+
+## Features
+
+- 🧠 **Typed Payloads** using Python dataclasses
+- 🧵 **Priority-based concurrent callbacks** for message handling
+- 📦 **ISA-95 topic modeling** for enterprise-ready messaging structures
+- 🔒 **TLS support** with environment-based auto-configuration
+- 🧪 **Validation-ready** versioning and context-driven payload classes
+- 📊 **MQTT-based logging** with seamless integration
+
+## Installation
+
+Install using pip:
+
+```bash
+pip install franzmq
+```
+
+## Quick Start
+
+```python
+from franzmq.client import Client
+from franzmq.payload import Metric
+from franzmq.topic import Topic
+
+client = Client.autocreate_and_connect(client_id="my-client")
+
+topic = Topic(payload_type=Metric, context=("sensor", "temperature"))
+metric = Metric(value=22.5)
+
+client.publish(topic, metric)
+```
+
+## Typed Payloads
+
+All messages use structured dataclasses (e.g., `Metric`, `Log`, `ServiceDetails`, etc.) that encode/decode automatically to/from JSON.
+
+## Logging over MQTT
+
+Enable logging by calling:
+
+```python
+client.configure_mqtt_logger(level=logging.INFO)
+```
+
+## Auto Configuration via Environment Variables
+
+Uses [`python-decouple`](https://github.com/henriquebastos/python-decouple) for environment configuration.
+
+### Required Variables
+
+- `MQTT_IP`
+- `MQTT_USERNAME`
+- `MQTT_PASSWORD`
+- `MQTT_PORT` (optional)
+- `USE_MQTTS`
+- `CA_CERT_FILE` (optional)
+- `TLS_CERT_FILE` (optional)
+- `TLS_KEY_FILE` (optional)
+
+## Callback System
+
+Subscribe to topics and register priority-based callbacks:
+
+```python
+client.subscribe(topic, qos=1, callback=my_callback, priority=10)
+```
+
+Callbacks with the same priority are executed concurrently; higher-priority callbacks run first.
+
+## Payload Types
+
+Includes predefined payloads such as:
+
+- `Metric`
+- `Log`
+- And many more are easily self-definable...
+
+## Testing ISA-95 Topics
+
+```python
+from franzmq.topic import Isa95Topic, Topic, Isa95Fields
+
+basic_topic = Topic(payload_type=Metric, context=("sensor", "temperature"))
+isa95_fields = Isa95Fields(enterprise="ent1", site="s1", area="a1", production_line="pl1", work_cell="wc1", origin_id="origin1")
+isa95_topic = Isa95Topic.from_topic(basic_topic, isa95_fields)
+```
+
+## License
+
+MIT License

franzmq-0.4.0b3/README.md

@@ -0,0 +1,94 @@
+# FranzMQ
+
+**FranzMQ** is a flexible, structured MQTT communication library designed to streamline MQTT messaging for internal and external communication in edge and cloud applications. It builds on top of the `paho-mqtt` client and introduces a typed, hierarchical topic and payload system based on the ISA-95 model.
+
+## Features
+
+- 🧠 **Typed Payloads** using Python dataclasses
+- 🧵 **Priority-based concurrent callbacks** for message handling
+- 📦 **ISA-95 topic modeling** for enterprise-ready messaging structures
+- 🔒 **TLS support** with environment-based auto-configuration
+- 🧪 **Validation-ready** versioning and context-driven payload classes
+- 📊 **MQTT-based logging** with seamless integration
+
+## Installation
+
+Install using pip:
+
+```bash
+pip install franzmq
+```
+
+## Quick Start
+
+```python
+from franzmq.client import Client
+from franzmq.payload import Metric
+from franzmq.topic import Topic
+
+client = Client.autocreate_and_connect(client_id="my-client")
+
+topic = Topic(payload_type=Metric, context=("sensor", "temperature"))
+metric = Metric(value=22.5)
+
+client.publish(topic, metric)
+```
+
+## Typed Payloads
+
+All messages use structured dataclasses (e.g., `Metric`, `Log`, `ServiceDetails`, etc.) that encode/decode automatically to/from JSON.
+
+## Logging over MQTT
+
+Enable logging by calling:
+
+```python
+client.configure_mqtt_logger(level=logging.INFO)
+```
+
+## Auto Configuration via Environment Variables
+
+Uses [`python-decouple`](https://github.com/henriquebastos/python-decouple) for environment configuration.
+
+### Required Variables
+
+- `MQTT_IP`
+- `MQTT_USERNAME`
+- `MQTT_PASSWORD`
+- `MQTT_PORT` (optional)
+- `USE_MQTTS`
+- `CA_CERT_FILE` (optional)
+- `TLS_CERT_FILE` (optional)
+- `TLS_KEY_FILE` (optional)
+
+## Callback System
+
+Subscribe to topics and register priority-based callbacks:
+
+```python
+client.subscribe(topic, qos=1, callback=my_callback, priority=10)
+```
+
+Callbacks with the same priority are executed concurrently; higher-priority callbacks run first.
+
+## Payload Types
+
+Includes predefined payloads such as:
+
+- `Metric`
+- `Log`
+- And many more are easily self-definable...
+
+## Testing ISA-95 Topics
+
+```python
+from franzmq.topic import Isa95Topic, Topic, Isa95Fields
+
+basic_topic = Topic(payload_type=Metric, context=("sensor", "temperature"))
+isa95_fields = Isa95Fields(enterprise="ent1", site="s1", area="a1", production_line="pl1", work_cell="wc1", origin_id="origin1")
+isa95_topic = Isa95Topic.from_topic(basic_topic, isa95_fields)
+```
+
+## License
+
+MIT License

franzmq-0.4.0b3/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "franzmq"
+version = "0.4.0b3"
+description = "Typed MQTT client and topic/payload model for ISA-95-ish messaging."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "Alpamayo", email = "info@alpamayo-solutions.com" }]
+dependencies = [
+  "paho-mqtt>=2.0",        
+  "python-decouple>=3.8",  
+]
+
+# These show up on PyPI
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Topic :: Internet",
+  "Topic :: System :: Networking",
+]
+
+[project.urls]
+Homepage = "https://github.com/alpamayo-solutions/franzmq"
+Issues = "https://github.com/alpamayo-solutions/franzmq/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = true
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2.1",
+  "twine>=5.0.0",
+  "pytest>=8.0",
+  "ruff>=0.5.0",
+  "black>=24.0",
+  "mypy>=1.10",
+]

franzmq-0.4.0b3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

franzmq-0.4.0b3/src/franzmq/__init__.py

@@ -0,0 +1,14 @@
+from .client import Client
+from .topic import Topic, Isa95Fields, Isa95Topic
+from .topic_base import TopicBase, classproperty
+from .message import Message
+from .data_contracts.base import Payload, Metric, Log, Cmd, Ack
+from .log_handlers import configure_logging
+
+__all__ = [
+    "Payload", "Message", "Topic", "Client",
+    "Isa95Fields", "Isa95Topic",
+    "Metric", "Log", "Cmd", "Ack",
+    "TopicBase", "classproperty",
+    "configure_logging",
+]