# **PySparkplug**: Sparkplug B for Python
[](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml)
[](https://pysparkplug.mattefay.com)
[](https://pepy.tech/project/pysparkplug)
[](https://pypi.org/project/pysparkplug/)
[](https://codecov.io/gh/matteosox/pysparkplug)
## Getting Started
### Installation
`pysparkplug` is a pip-installable package [hosted on PyPI](https://pypi.org/project/pysparkplug/). Getting started is as easy as:
```console
$ pip install pysparkplug
```
`pysparkplug` uses the Eclipse Paho™ MQTT Python Client, i.e. [`paho-mqtt`](https://github.com/eclipse/paho.mqtt.python), 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "pysparkplug",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "automation, manufacturing, mqtt, sparkplug",
"author": null,
"author_email": "Matt Fay <matt.e.fay@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/21/0f/5e937703fb8691f18fbfdcd8ae693b5a009793edce5b7c37b16c1ceb5996/pysparkplug-0.5.0.tar.gz",
"platform": null,
"description": "# **PySparkplug**: Sparkplug B for Python\n\n[](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml)\n[](https://pysparkplug.mattefay.com)\n[](https://pepy.tech/project/pysparkplug)\n[](https://pypi.org/project/pysparkplug/)\n[](https://codecov.io/gh/matteosox/pysparkplug)\n\n## Getting Started\n\n### Installation\n\n`pysparkplug` is a pip-installable package [hosted on PyPI](https://pypi.org/project/pysparkplug/). Getting started is as easy as:\n\n```console\n$ pip install pysparkplug\n```\n\n`pysparkplug` uses the Eclipse Paho\u2122 MQTT Python Client, i.e. [`paho-mqtt`](https://github.com/eclipse/paho.mqtt.python), for low-level MQTT communication.\n\n### Usage\n\nSimple 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`.\n\n## Features\n\n### Fully type annotated\n\n`pysparkplug`'s various interfaces are fully type annotated.\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "An open-source, Python implementation of Sparkplug B, an MQTT topic and payload definition standard",
"version": "0.5.0",
"project_urls": {
"Bug Report": "https://github.com/matteosox/pysparkplug/issues/new/choose",
"Changelog": "https://pysparkplug.mattefay.com/en/stable/changelog.html",
"Documentation": "https://pysparkplug.mattefay.com",
"Feature Request": "https://github.com/matteosox/pysparkplug/issues/new/choose",
"Source": "https://github.com/matteosox/pysparkplug"
},
"split_keywords": [
"automation",
" manufacturing",
" mqtt",
" sparkplug"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cbf6b9137c189d638e4d7c94a762b1d7ab1d1b27f98b85444bc74b3a248762f1",
"md5": "1cc1055275bf4d00302472cd21925dac",
"sha256": "80d957feda6df28c53ebc53cac9a15087fa57abc5a91247945a94d2379a4a084"
},
"downloads": -1,
"filename": "pysparkplug-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cc1055275bf4d00302472cd21925dac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 30633,
"upload_time": "2025-01-10T02:00:02",
"upload_time_iso_8601": "2025-01-10T02:00:02.246184Z",
"url": "https://files.pythonhosted.org/packages/cb/f6/b9137c189d638e4d7c94a762b1d7ab1d1b27f98b85444bc74b3a248762f1/pysparkplug-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "210f5e937703fb8691f18fbfdcd8ae693b5a009793edce5b7c37b16c1ceb5996",
"md5": "d6f35bd272fdd21fa027da8cc01a2de5",
"sha256": "842806fd696571de138b8aa8b13cb09687dba5ba2a9ae461b87607dc6b486bf0"
},
"downloads": -1,
"filename": "pysparkplug-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "d6f35bd272fdd21fa027da8cc01a2de5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 256967,
"upload_time": "2025-01-10T02:00:04",
"upload_time_iso_8601": "2025-01-10T02:00:04.210603Z",
"url": "https://files.pythonhosted.org/packages/21/0f/5e937703fb8691f18fbfdcd8ae693b5a009793edce5b7c37b16c1ceb5996/pysparkplug-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 02:00:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matteosox",
"github_project": "pysparkplug",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pysparkplug"
}
JSON
