# **PySparkplug**: Sparkplug B for Python
[![CI/CD: n/a](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml/badge.svg)](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml)
[![Docs: n/a](https://readthedocs.org/projects/pysparkplug/badge/?version=stable)](https://pysparkplug.mattefay.com)
[![Downloads: n/a](https://static.pepy.tech/personalized-badge/pysparkplug?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/pysparkplug)
[![PyPI: n/a](https://img.shields.io/badge/dynamic/json?color=blueviolet&label=PyPI&query=%24.info.version&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fpysparkplug%2Fjson)](https://pypi.org/project/pysparkplug/)
[![codecov: n/a](https://codecov.io/gh/matteosox/pysparkplug/branch/main/graph/badge.svg?token=8VKKDG9SMZ)](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
More documentation to come later, but for now, you can find some example usage notebooks in the `notebooks` directory.
## Features
### Fully type annotated
`pysparkplug`'s various interfaces are fully type annotated, passing [Mypy](https://mypy.readthedocs.io/en/stable/)'s static type checker.
Raw data
{
"_id": null,
"home_page": "",
"name": "pysparkplug",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "automation,manufacturing,mqtt,sparkplug",
"author": "",
"author_email": "Matt Fay <matt.e.fay@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ce/95/dc5cec82729e10b16a671de4fee433ceef9daa0175c49281d862ced180c9/pysparkplug-0.3.1.tar.gz",
"platform": null,
"description": "# **PySparkplug**: Sparkplug B for Python\n\n[![CI/CD: n/a](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml/badge.svg)](https://github.com/matteosox/pysparkplug/actions/workflows/cicd.yaml)\n[![Docs: n/a](https://readthedocs.org/projects/pysparkplug/badge/?version=stable)](https://pysparkplug.mattefay.com)\n[![Downloads: n/a](https://static.pepy.tech/personalized-badge/pysparkplug?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/pysparkplug)\n[![PyPI: n/a](https://img.shields.io/badge/dynamic/json?color=blueviolet&label=PyPI&query=%24.info.version&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fpysparkplug%2Fjson)](https://pypi.org/project/pysparkplug/)\n[![codecov: n/a](https://codecov.io/gh/matteosox/pysparkplug/branch/main/graph/badge.svg?token=8VKKDG9SMZ)](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\nMore documentation to come later, but for now, you can find some example usage notebooks in the `notebooks` directory.\n\n## Features\n\n### Fully type annotated\n\n`pysparkplug`'s various interfaces are fully type annotated, passing [Mypy](https://mypy.readthedocs.io/en/stable/)'s static type checker.\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.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/matteosox/pysparkplug/issues",
"Changelog": "https://pysparkplug.mattefay.com/en/stable/changelog.html",
"Documentation": "https://pysparkplug.mattefay.com",
"Source": "https://github.com/matteosox/pysparkplug"
},
"split_keywords": [
"automation",
"manufacturing",
"mqtt",
"sparkplug"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ff4af36af9048389fa2a64de142f7c29cae25f49b725aa3adeae543379b21f4",
"md5": "a7af90ea80286674d78f04adb913f751",
"sha256": "488baec50e07f150aa63c24a52b12cccfa7c58caff9587a81fa7656c4d187e8a"
},
"downloads": -1,
"filename": "pysparkplug-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7af90ea80286674d78f04adb913f751",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 28802,
"upload_time": "2024-02-14T02:57:02",
"upload_time_iso_8601": "2024-02-14T02:57:02.699462Z",
"url": "https://files.pythonhosted.org/packages/2f/f4/af36af9048389fa2a64de142f7c29cae25f49b725aa3adeae543379b21f4/pysparkplug-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce95dc5cec82729e10b16a671de4fee433ceef9daa0175c49281d862ced180c9",
"md5": "efbdbf185dd5501e7dcbba3e8cb6ee85",
"sha256": "3b6548a23aabbcf999ca051da1a04956f744d712782bdde45acae349b6726e9e"
},
"downloads": -1,
"filename": "pysparkplug-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "efbdbf185dd5501e7dcbba3e8cb6ee85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 179260,
"upload_time": "2024-02-14T02:57:04",
"upload_time_iso_8601": "2024-02-14T02:57:04.110496Z",
"url": "https://files.pythonhosted.org/packages/ce/95/dc5cec82729e10b16a671de4fee433ceef9daa0175c49281d862ced180c9/pysparkplug-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 02:57: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"
}