Metadata-Version: 2.1
Name: webthing-ws
Version: 0.1.2
Summary: A WebThing WebSocket consumer and API client.
Home-page: https://github.com/home-assistant-ecosystem/webthing-ws
Author: Fabian Affolter
Author-email: fabian@affolter-engineering.ch
License: MIT
Download-URL: https://github.com/home-assistant-ecosystem/webthing-ws/releases
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Requires-Python: >=3.8
License-File: LICENSE

webthing-ws
===========

A  `WebThing <https://iot.mozilla.org/wot/>`_ WebSocket consumer and API client.

Installation
------------

The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.

.. code:: bash

    $ pip3 install webthing-ws

On a Fedora-based system or on a CentOS/RHEL host with EPEL 8.

.. code:: bash

    $ sudo dnf -y install python3-webthing-ws

Usage
-----

The file ``example.py`` contains an example about how to use this module.

Development
-----------

For development is recommended to use a ``venv``. Create it in the directory
after cloning the Git repository.

.. code:: bash

    $ python3 -m venv .
    $ source bin/activate
    $ python3 setup.py develop

License
-------

``webthing-ws`` is licensed under MIT, for more details check LICENSE.


