# unide.python

**Repository Path**: mirrors_eclipse/unide.python

## Basic Information

- **Project Name**: unide.python
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

============
Unide Python
============

.. image:: https://img.shields.io/travis/eclipse/unide.python/master.svg
    :alt: Travis-CI badge
    :target: https://travis-ci.org/eclipse/unide.python

.. image:: https://img.shields.io/coveralls/eclipse/unide.python/master.svg
    :alt: Coveralls badge
    :target: https://coveralls.io/r/eclipse/unide.python?branch=master

.. .. image:: https://img.shields.io/pypi/v/unide-python.svg
    :alt: PyPI latest version badge
    :target: https://pypi.python.org/pypi/unide-python/

.. image:: https://readthedocs.org/projects/unidepython/badge/?version=latest
   :alt: Read the Docs
   :target: http://unidepython.readthedocs.io/en/latest/

.. .. image:: https://img.shields.io/pypi/format/unide-python.svg
    :alt: Download format
    :target: http://pythonwheels.com/

.. .. image:: https://img.shields.io/pypi/l/unide-python.svg
    :alt: Unide license
    :target: https://pypi.python.org/pypi/unide-python/

This Python package is part of the `Eclipse Unide Project
<https://www.eclipse.org/unide>`_ and provides an API for generating,
parsing and validating PPMP payloads. PPMP, the `"Production
Performance Management Protocol"
<https://www.eclipse.org/unide/specification>`_ is a simple,
JSON-based protocol for message payloads in (Industrial) Internet of
Things applications defined by the `Eclipse IoT Working Group
<https://iot.eclipse.org/>`_. Implementations for other programming
languages are available from the Unide web site.

The focus of the Python implementation is ease of use for backend
implementations, tools and for prototyping PPMP
applications. Generating a simple payload and sending it over MQTT
using `Eclipse Paho <https://github.com/eclipse/paho.mqtt.python>`_ is
a matter of just a few lines::

  import unide
  import paho.mqtt.client as mqtt

  client = mqtt.Client()
  client.connect("localhost", 1883, 60)
  device = unide.Device("Device-001")
  measurement = device.measurement(temperature=36.7)
  client.publish(topic="sample", measurement)

Installation
============

The latest version is available in the Python Package Index (PyPI) and
can be installed using::

  pip install unide-python

``unide-python`` can be used with Python 2.7, 3.4, 3.5 and 3.6.

Source code, including examples and tests, is available on GitHub:
https://github.com/eclipse/unide.python

To install the package from source::

  git clone git@github.com:eclipse/unide.python.git
  cd unide.python
  python setup.py install


Contributing
============

Please refer to `<CONTRIBUTING.rst>`_

Documentation
=============

Detailed documentation is available on Read the Docs:
http://unidepython.readthedocs.io/en/latest/.