Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/home-assistant-ecosystem/webthing-ws

WebThing WebSocket consumer and API client.
https://github.com/home-assistant-ecosystem/webthing-ws

home-assistant mozilla-iot smart-home webthing webthings

Last synced: 3 days ago
JSON representation

WebThing WebSocket consumer and API client.

Awesome Lists containing this project

README

        

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

A `WebThing `_ WebSocket consumer and API client.

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

The module is available from the `Python Package Index `_.

.. 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

For Nix or NixOS users is a package available. Keep in mind that the lastest releases might only
be present in the ``unstable`` channel.

.. code:: bash

$ nix-env -iA nixos.python3Packages.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.