Skip to main content

Heisskleber

PyPI Python Version License

Read the documentation at https://heisskleber.readthedocs.io/ Tests codecov

pre-commit Format

🇩🇪Heißkleber m: "hot glue".

Heisskleber is a versatile library designed to seamlessly "glue" together various data producers and consumers across a multitude of protocols including zmq, mqtt, udp, serial, influxdb, and cmdline. With the ambition to extend into REST API interactions and file operations, Heisskleber offers both synchronous and asynchronous interfaces to cater to a wide range of IoT connectivity needs.

Features

  • Multiple Protocol Support: Easy integration with zmq, mqtt, udp, serial, and cmdline. Future plans include REST API and file operations.
  • Custom Data Handling: Customizable "unpacker" and "packer" functions allow for the translation of any data format (e.g., ascii encoded, comma-separated messages from a serial bus) into dictionaries for easy manipulation and transmission.
  • Extensible: Designed for easy extension with additional protocols and data handling functions.

Installation

You can install Heisskleber via pip from PyPI:

$ pip install heisskleber

Quick Start

Here's a simple example to demonstrate how Heisskleber can be used to connect a serial input to an mqtt output:

"""
A simple forwarder that takes messages from a serial device and publishes them via MQTT.
"""
import asyncio

from heisskleber.serial import SerialReceiver, SerialConf
from heisskleber.mqtt import MqttSender, MqttConf


async def main():
  source = SerialSubscriber(config=SerialConf(port="/dev/ACM0", baudrate=9600))
  sink = MqttPublisher(config=MqttConf(host="mqtt.example.com", port=1883, user="", password=""))

  while True:
      data, metadata = await source.receive()
      await sink.send(data, topic="/hotglue/" + metadata.get("topic", "serial"))

asyncio.run(main())

All sources and sinks come with customizable "unpacker" and "packer" functions, making it simple to work with various data formats.

See the documentation for detailed usage.

License

Distributed under the terms of the MIT license, Heisskleber is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Metadata

Release files for heisskleber 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for heisskleber 1.2.1
File Size Uploaded Provenance
heisskleber-1.2.1.tar.gz 98.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for heisskleber 1.2.1
File Interpreter ABI Platform
heisskleber-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 135.8 kB

Release files / heisskleber-1.2.1.tar.gz

Download URL heisskleber-1.2.1.tar.gz
Size 98.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ef8edc84f7757631a0400583a65a3cebbc860a745fea5e5f6e35fcfccea868b5
BLAKE2b-256 checksum
How to use checksums
259de43179feb82b73e87b49166167b9321c238dad29e52efcb7be093232a2f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.5.10

Release files / heisskleber-1.2.1-py3-none-any.whl

Download URL heisskleber-1.2.1-py3-none-any.whl
Size 37.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a0500e33591a294bb906dc89c29c9bf20af5e2d60f19d8e0fb09c994ed0549e8
BLAKE2b-256 checksum
How to use checksums
a9bb169b0fa6ec6cfb6a57a298d151084904bdbcd78fccb983a749d7b7927d62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.5.10

Security for heisskleber 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.2.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page