Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.67 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.67 KB

PySparkplug: Sparkplug B for Python

CI/CD: n/a Docs: n/a Downloads: n/a PyPI: n/a codecov: n/a

Getting Started

Installation

pysparkplug is a pip-installable package hosted on PyPI. Getting started is as easy as:

$ pip install pysparkplug

pysparkplug uses the Eclipse Paho™ MQTT Python Client, i.e. paho-mqtt, for low-level MQTT communication.

Usage

Simple demos of the EdgeNode, Device, and Client classes publishing and subscribing all supported payloads and metric datatypes can be found in the notebooks directory. To run them dynamically, you'll need to install Docker and run just notebooks before opening up your local browser to http://localhost:8888. The password is bokchoy.

Features

Fully type annotated

pysparkplug's various interfaces are fully type annotated.