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: about 2 months ago
JSON representation

WebThing WebSocket consumer and API client.

• Host: GitHub
• URL: https://github.com/home-assistant-ecosystem/webthing-ws
• Owner: home-assistant-ecosystem
• License: mit
• Created: 2019-11-21T20:31:44.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T13:03:48.000Z (2 months ago)
• Last Synced: 2024-10-28T16:46:33.083Z (2 months ago)
• Topics: home-assistant, mozilla-iot, smart-home, webthing, webthings
• Language: Python
• Homepage:
• Size: 50.8 KB
• Stars: 7
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

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.