pysparkplug

Name	pysparkplug JSON
Version	0.4.0 JSON
	download
home_page	None
Summary	An open-source, Python implementation of Sparkplug B, an MQTT topic and payload definition standard
upload_time	2024-10-24 06:53:06
maintainer	None
docs_url	None
author	None
requires_python	>=3.9
license	Apache License, Version 2.0
keywords	automation manufacturing mqtt sparkplug
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # **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": 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/86/57/81a474c978f51fc38faf5ca664a2dd7163b8ce93d92486bcf7c2f716e818/pysparkplug-0.4.0.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.4.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": "acb64c25de60203ccfb80f19754e7fab25d1feaaaa18e9993a21234ccb04127c",
                "md5": "acf99ba6e7b32ccad54869472c57eeb2",
                "sha256": "e713b0454418ab5fb374b51c3ec3b70629d5c44ab4e761c7d1d9f1c1897b804d"
            },
            "downloads": -1,
            "filename": "pysparkplug-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "acf99ba6e7b32ccad54869472c57eeb2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 29275,
            "upload_time": "2024-10-24T06:53:05",
            "upload_time_iso_8601": "2024-10-24T06:53:05.334882Z",
            "url": "https://files.pythonhosted.org/packages/ac/b6/4c25de60203ccfb80f19754e7fab25d1feaaaa18e9993a21234ccb04127c/pysparkplug-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "865781a474c978f51fc38faf5ca664a2dd7163b8ce93d92486bcf7c2f716e818",
                "md5": "41540aad6fb1bfcee426462d5e38f36e",
                "sha256": "51249dbd054472bbbb494effa11c7140a534c085c6846dfcc0d28cc8473081aa"
            },
            "downloads": -1,
            "filename": "pysparkplug-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "41540aad6fb1bfcee426462d5e38f36e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 230872,
            "upload_time": "2024-10-24T06:53:06",
            "upload_time_iso_8601": "2024-10-24T06:53:06.948843Z",
            "url": "https://files.pythonhosted.org/packages/86/57/81a474c978f51fc38faf5ca664a2dd7163b8ce93d92486bcf7c2f716e818/pysparkplug-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 06:53:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "matteosox",
    "github_project": "pysparkplug",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pysparkplug"
}