[#400] Dynamic logic to infer procedures/hooks arguments.

This allows procedures and event hooks to have more flexible signatures.
Along the lines of:

```python
@when(SomeEvent)
def hook(event):
  ...

@when(SomeOtherEvent)
def hook2():
  ...
```

Instead of supporting only the full context spec:

```python
@when(SomeEvent)
def hook(event, **ctx):
  ...
```

Closes: #400

.dockerignore

@@ -0,0 +1,6 @@
+**/.git
+**/node_modules
+**/__pycache__
+**/venv
+**/.mypy_cache
+**/build

.gitignore

@@ -3,17 +3,28 @@
 *.pyc
 __pycache__
 build/
-dist/
+/dist/
 *.egg-info/
 package.sh
 .pypirc
 platypush/backend/http/static/resources/*
 docs/build
 .idea/
-config
+/config
 platypush/backend/http/static/css/*/.sass-cache/
 .vscode
 platypush/backend/http/static/js/lib/vue.js
 platypush/notebooks
 platypush/requests
 /http-client.env.json
+/platypush/backend/http/static/css/dist
+/tests/etc/dashboards
+.coverage
+coverage.xml
+Session.vim
+/jsconfig.json
+/package.json
+/Dockerfile
+/docs/source/wiki
+/.skipci
+dump.rdb

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "docs/wiki"]
-	path = docs/wiki
-	url = https://github.com/BlackLight/platypush.wiki.git
 [submodule "platypush/plugins/gpio/sensor/ir/mlx90640/lib"]
 	path = platypush/plugins/camera/ir/mlx90640/lib
 	url = https://github.com/pimoroni/mlx90640-library

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    # -   id: trailing-whitespace
+    # -   id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-json
+    - id: check-xml
+    - id: check-symlinks
+    - id: check-added-large-files
+      args: ['--maxkb=1500']
+
+-   repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
+    rev: v1.1.2
+    hooks:
+    -   id: markdown-toc
+
+- repo: https://github.com/pycqa/flake8
+  rev: 4.0.1
+  hooks:
+    - id: flake8
+      additional_dependencies:
+        - flake8-bugbear
+        - flake8-comprehensions
+        - flake8-simplify
+
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    -   id: black

.readthedocs.yml

@@ -1,7 +0,0 @@
-build:
-  image: latest
-
-python:
-  version: 3.6
-  setup_py_install: true
-

.travis.requirements

@@ -1,10 +0,0 @@
-pyyaml
-requires
-requests
-flask
-redis
-python-dateutil
-websockets
-bcrypt
-sqlalchemy
-croniter

.travis.yml

@@ -1,22 +0,0 @@
-language: python
-dist: xenial
-python:
-  - "3.7"
-
-install: "pip install -r .travis.requirements"
-
-script: ./run_tests.sh
-
-notifications:
-    email:
-        recipients:
-            - blacklight86@gmail.com
-        on_success: change
-        on_failure: change
-
-services:
-    - redis-server
-
-git:
-    submodules: false
-

CHANGELOG.md

@@ -0,0 +1,749 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+Given the high speed of development in the first phase, changes are being
+reported only starting from v0.20.2.
+
+## [0.50.3] - 2023-07-22
+
+### Added
+
+- Added [XMPP plugin](https://git.platypush.tech/platypush/platypush/pulls/269).
+
+## [0.50.2] - 2023-06-30
+
+### Fixed
+
+- A fix for the new `get_plugin` supported syntax. `get_plugin` now also
+  accepts a plugin class/type as an argument rather than a string, but the
+  previous logic didn't properly inspect the parent module.
+
+## [0.50.0] - 2023-06-28
+
+This should actually be a new big major release, but I'm holding on implementing
+more features before a 1.0 tag.
+
+### Added
+
+- Migrated many integrations to the new [entities
+  framework](https://git.platypush.tech/platypush/platypush/pulls/230).
+  This is a very large change to the foundations of the platform. Many plugins
+  (and many others will follow) now publish and store their *entities* in a
+  standard format, so e.g. all the lights, switches, Bluetooth devices, cameras,
+  audio devices, media players and sensors are now supposed to expose the same
+  attributes and API regardless of the type of integration. This refactor also
+  includes a new default home panel, which includes all the entities detected by
+  the registered integrations. Many integrations have already been migrated to
+  the new framework. Among them (and many others are on their way):
+
+  - `arduino`
+  - `bluetooth`
+  - `light.hue`
+  - `linode`
+  - All the `sensor.*` plugins
+  - `serial`
+  - `smartthings`
+  - `switchbot`
+  - `system`
+  - `variable`
+  - `zigbee.mqtt`
+  - `zwave.mqtt`
+
+- Added support for more complex filters on event hooks. Earlier filters could
+  only model key-value pair matches. The interface now supports more
+  sophisticated filters - among these, structured filters with partial matches
+  and relational filters. For example:
+
+```python
+from platypush.event.hook import hook
+from platypush.message.event.sensor import SensorDataChangeEvent
+
+@hook(SensorDataChangeEvent, data=1):
+def hook_1(event):
+    """
+    Triggered when event.data == 1
+    """
+
+@hook(SensorDataChangeEvent, data={'state': 1}):
+def hook_2(event):
+    """
+    Triggered when event.data['state'] == 1
+    """
+
+@hook(SensorDataChangeEvent, data={
+  'temperature': {'$gt': 25},
+  'humidity': {'$le': 15}
+}):
+def hook_3(event):
+    """
+    Triggered when event.data['temperature'] > 25 and
+    event.data['humidity'] <= 15.
+    """
+```
+
+The supported relational fields are the same supported by ElasticSearch - `$gt`
+for greater than, `$lt` for lesser than, `$ge` for greater or equal, `$ne` for
+not equal, etc.
+
+This also means that the previous `SensorDataAboveThresholdEvent` and
+`SensorDataBelowThresholdEvent` events are now deprecated, as the new hook API
+makes it much easier and flexible to define custom threshold logic on any events
+without having to pre-define thresholds in each backend's configuration.
+
+- Added a Progressive WebApp (PWA) framework to the Vue webapp. It is now
+  possible to install Platypush as a stand-alone webapp directly from the web
+  panel if the panel is served over HTTPS. For now this only improves the user
+  experience, performance and it provides a more native-like experience on
+  mobile, but in the future the PWA background worker could be used to e.g.
+  deliver asynchronous events and notifications to the clients without keeping
+  the browser open.
+
+- Added support for application database automatic migrations after an update by
+  using Alembic.
+
+### Changed
+
+- Tornado is now used as an HTTP engine by `backend.http`, instead of using
+  bare bone Flask with its inefficient Werkzeug server and an optional uwsgi
+  that required extra configuration (and an extra external service).
+
+- All the streaming endpoints have been rewritten and adapted to work with
+  Tornado. This greatly improves performance, stability and ease of
+  configuration, while remaining back-compatible with the previous URL formats.
+  As a side note, all the streaming endpoints are now using Redis to stream
+  information across multiple worker processes, so make sure that you have a
+  version of Redis that supports pub/sub (most of the recent ones should do).
+
+- The `bluetooth` plugin has been completely rewritten, merged with the (now
+  deprecated) `backend.bluetooth`. The previously separated low-energy/legacy
+  integrations have now been merged too. It now supports much more than passive
+  scanning, as it can recognize the information published by most of the device,
+  supports both legacy and low-energy connection/disconnection actions, and it
+  can detect most of the device classes, services and manufacturers. It also
+  supports parsing some standard features (like battery level, temperature,
+  state etc.) if they are published according to some convention supported by
+  *TheengsGateway*. The `switchbot.bluetooth` integration has now also been
+  merged into `bluetooth`.
+
+- The `sound` plugin has been completely rewritten. While it should still be
+  largely back-compatible with the previous implementation, you should probably
+  go and take a look at the new documentation to get a grasp of the new
+  features.
+
+- The `camera.ffmpeg` plugin has received a big rewrite that has improved its
+  stability and robustness against several types of cameras. It is now the
+  recommended way of interfacing with general-purpose cameras, even for
+  PiCameras - the `camera.pi` integration is now largely deprecated, as the old
+  PiCamera API is deprecated as well, and `camera.ffmpeg` should now work out of
+  the box with a PiCamera if a reasonably recent version of ffmpeg is installed.
+
+- `backend.websocket` has been **removed** and replaced by Tornado asynchronous
+   websocket URLs registered on the HTTP backend. The two new routes that
+   replace the websocket backend are:
+
+  - `/ws/events`: subscribe to this websocket to receive any asynchronous
+    events forwarded by the application.
+  - `/ws/requests`: you can send request messages to this endpoints, and the
+    responses will be received asynchronously on the same channel.
+
+- The `inspect` plugin has been largely improved.
+
+  - Its performance is now much snappier, as it scans for all the available
+    integrations by searching for manifest files instead of scanning each
+    single source file. Documentation about specific plugins and actions is
+    fetched lazily when requested by the user.
+  - It now also caches results by looking at the last modified date of the
+    source file, so it won't have to re-scan source files that haven't been
+    modified.
+  - Its detection of RST constructs has also been improved, so most of the code
+    blocks, schemas, return types and references to other objects are now
+    rendered in the plugin UI.
+
+- Added `variable.delete` action. The existing `variable.unset` action will now
+  only set a variable to null if it exists, while `variable.delete` will
+  actually remove it from the database.
+
+- `backend.sensor.distance` and `gpio.sensor.distance` have been removed and
+  migrated instead to a new `sensor.hcsr04` plugin, since the existing logic
+  actually only applies to HC-SR04-like distance sensors.
+
+- `backend.sensor.dht` and `gpio.sensor.dht` have been removed and
+  migrated to a new `sensor.dht` plugin.
+
+- `backend.sensor.accelerometer` and `gpio.sensor.accelerometer` have been
+  removed and migrated to a new `sensor.lis3dh` plugin, since the existing
+  accelerometer logic only works with these sensors.
+
+- `backend.sensor.motion.pwm3901` and `gpio.sensor.motion.pwm3901` have been
+  removed and migrated to a new `sensor.pwm3901` plugin.
+  accelerometer logic only works with these sensors.
+
+- `backend.sensor.envirophat` and `gpio.sensor.envirophat` have been removed and
+  migrated to a new `sensor.envirophat` plugin.
+
+- `backend.sensor.ltr559` and `gpio.sensor.ltr559` have been removed and
+  migrated to a new `sensor.ltr559` plugin.
+
+- `backend.sensor.bme280` and `gpio.sensor.bme280` have been removed and
+  migrated to a new `sensor.bme280` plugin.
+
+- `backend.sensor.distance.vl53l1x` and `gpio.sensor.distance.vl53l1x` have been
+  removed and migrated to a new `sensor.vl53l1x` plugin.
+
+- `backend.serial` has been removed and merged into the `serial` plugin.
+
+- `backend.switch.wemo` has been removed and merged into the `switch.wemo`
+  plugin.
+
+- `backend.switch.tplink` has been removed and merged into the `switch.tplink`
+  plugin.
+
+- `backend.zigbee.mqtt` has been removed and merged into the `zigbee.mqtt`
+  plugin.
+
+- `backend.zwave.mqtt` has been removed and merged into the `zwave.mqtt` plugin.
+
+### Fixed
+
+- Notable performance improvements for the UI (like -50% on the load time and
+  memory usage in some cases). Recursive/reflective Vue components now use
+  `shallowRef`, so complex UI models won't have to be fully loaded at page
+  start.
+
+- Fixed compatibility with SQLAlchemy 2.
+
+- Migrated the `clipboard` integration from `pyperclip` to `pyclip` (see
+  [#240](https://git.platypush.tech/platypush/platypush/issues/240)).
+  `pyperclip` is unmaintained and largely broken, and `pyclip` seems to be a
+  viable drop-in alternative.
+
+- Better implementation of the UI modals - added close buttons and trigger
+  closure when Esc is pressed.
+
+### Removed
+
+- Removed SSL configuration from `backend.http`. Configuring SSL on
+  Flask+Tornado is messy, and it won't end up with a good user experience.
+  Instead, you should consider using a reverse proxy (e.g. nginx or Apache) if
+  you want to make the Platypush web interface available over HTTPS. A sample
+  nginx configuration has been added under `examples/nginx`. Note that running
+  the web panel over HTTPS is a requirement if you want to leverage the PWA
+  features, as a PWA can only be served over HTTPS.
+
+- Removed the Bluetooth file server integration. It is still possible to send
+  files over Bluetooth (the feature has now been merged into the `bluetooth`
+  plugin, under `bluetooth.send_file`), but all the server features rely on
+  features of PyOBEX that are now very broken on recent versions of Python (the
+  project itself hasn't been updated in years).
+
+- Removed or deprecated all the `backend.sensor.*` backends. Their logic has now
+  been merged into their associated plugins, and the plugins will have the
+  ability to run in the background too.
+
+- Removed `backend.sensor.battery`. It has now been merged into the `system`
+  plugin.
+
+- Removed `gpio.sensor` plugin. It was never really fully implemented, and it
+  was probably impossible to implement with an interface that could work with
+  any sensor-like device connected over GPIO.
+
+## [0.24.5] - 2023-02-22
+
+### Added
+
+- Added `hid` plugin to support discoverability and data interaction with
+  generic HID devices - like Bluetooth/USB peripherals, joysticks, dongles and
+  any other type of devices that supports the HID interface.
+  
+- Added `timeout` parameter to `websocket.send` to prevent messages sent on a
+  non-responsive websocket from getting the websocket loop stuck
+
+### Fixed
+
+- Running the Zeroconf registration logic in another thread in `backend.http`,
+  so failures in the Zeroconf logic don't affect the startup of the web server.
+  
+- (Temporarily) introduced `sqlalchemy < 2.0.0` as a requirement - a PR with a
+  migration to the new stable version of SQLAlchemy is in TODO.
+
+## [0.24.4] - 2022-12-20
+
+### Fixed
+
+- Fixed cronjobs potentially being triggered even if it wasn't their slot in
+  case of clock synchronization events.
+
+## [0.24.3] - 2022-12-17
+
+### Added
+
+- Added `[-v|--verbose]` command-line option to override the default logging
+  configuration and enable debug logging.
+- Added `--version` command-line option to print the current version and exit.
+- [[#236](https://git.platypush.tech/platypush/platypush/issues/236)] Added
+  support for `author` and `tags` attributes on feed entries.
+
+## [0.24.2] - 2022-12-10
+
+### Fixed
+
+- The `main.db` configuration should use the configured `workdir` when no
+  values are specified.
+
+- The `zwave.mqtt` is now compatible both with older (i.e. `zwavejs2mqtt`) and
+  newer (i.e. `ZwaveJS`) versions of the backend.
+
+## [0.24.1] - 2022-12-08
+
+### Fixed
+
+- Removed a parenthesized context manager that broke compatibility with
+  Python &lt; 3.10.
+
+## [0.24.0] - 2022-11-22
+
+### Added
+
+- Added [Wallabag integration](https://git.platypush.tech/platypush/platypush/issues/224).
+- Added [Mimic3 TTS integration](https://git.platypush.tech/platypush/platypush/issues/226).
+- Added `qos` attribute to `mqtt.publish` and all the plugins derived from `mqtt`.
+
+### Changed
+
+- Replaced PyJWT dependency with the Python-native `rsa` package. This will
+  make the installation much lighter, compatible with more systems and less
+  dependent on the platform-specific libraries required by `cryptography`.
+
+> **NOTE**: This is a breaking change for those who use the `backend.http` API
+> with JWT tokens. The new logic encrypts and encodes the payload in a
+> different format, therefore previously generated tokens are no longer
+> compatible.
+
+## [0.23.6] - 2022-09-19
+
+### Fixed
+
+- Fixed album_id and list of tracks on `music.tidal.get_album`.
+
+## [0.23.5] - 2022-09-18
+
+### Added
+
+- Added support for web hooks returning their hook method responses back to the
+  HTTP client.
+
+- Added [Tidal integration](https://git.platypush.tech/platypush/platypush/pulls/223)
+
+- Added support for [OPML
+  subscriptions](https://git.platypush.tech/platypush/platypush/pulls/220) to
+  the `rss` plugin.
+
+- Better support for bulk database operations on the `db` plugin.
+
+### Fixed
+
+- Now supporting YAML sections with empty configurations.
+
+## [0.23.4] - 2022-08-28
+
+### Added
+
+- Added `matrix` integration
+  ([issue](https://git.platypush.tech/platypush/platypush/issues/2),
+  [PR](https://git.platypush.tech/platypush/platypush/pulls/217)).
+
+### Changed
+
+- Removed `clipboard` backend. Enabling the `clipboard` plugin will also enable
+  clipboard monitoring, with no need for an additional backend.
+
+## [0.23.3] - 2022-06-01
+
+### Added
+
+- Added `ntfy` integration (see #219).
+- Support for a default `config.yaml` if one isn't specified in the default
+  locations.
+
+### Changed
+
+- The HTTP server dependencies are now marked as required, since the default
+  `config.yaml` will have the HTTP backend enabled by default in order to allow
+  the creation of a first user.
+- Updated Vue.js frontend dependencies to the latest version.
+- Removed bulma from the frontend dependencies, making the frontend much
+  lighter and loading times much faster.
+- Other UI improvements.
+
+### Fixed
+
+- More reliable cronjobs in case of DST change or any clock changes in general
+  (see #217).
+- Fixed `--redis-queue` argument.
+
+## [0.23.2] - 2022-03-27
+
+### Added
+
+- Support for asynchronous events over GPIO PINs. It is now possible to specify
+  a list of `monitored_pins` in the [`gpio`
+  plugin](https://git.platypush.tech/platypush/platypush/-/blob/master/platypush/plugins/gpio/__init__.py)
+  configuration. A change in the value on those GPIO PINs (caused by e.g. a
+  button, a binary sensor or a probe) will trigger a
+  `platypush.message.event.gpio.GPIOEvent` that you can use in your automation
+  scripts.
+
+- Simplified script API to interact with platform variables
+  (closes [#206](https://git.platypush.tech/platypush/platypush/-/issues/206)).
+  You can now read and write stored variables in your Platypush scripts through
+  a much more intuitive interface compared to explicitly using the `variable`
+  plugin explicitly:
+
+```python
+from platypush.context import Variable
+
+# ...
+
+my_var = Variable.get('my_var')
+my_var = int(my_var) + 1
+Variable.set(my_var=my_var)
+```
+
+## [0.23.0] - 2022-03-01
+
+### Added
+
+- Added [Jellyfin integration](https://git.platypush.tech/platypush/platypush/-/issues/208).
+
+### Fixed
+
+- Merged several PRs from `dependabot`.
+
+- Fixed management of the `CN` field in the `calendar.ical` plugin.
+
+## [0.22.10] - 2022-02-07
+
+### Added
+
+- Refactored the `dbus` integration. The plugin and backend have been merged into a
+  single plugin component, and the ability to subscribe to custom signals has been
+  added.
+
+### Fixed
+
+- Proper support for empty payloads on the integrations that trigger a `SensorDataChangeEvent`.
+- Fixed possible infinite recursion on the Pushbullet integration in case of errors where the
+  error and close handlers keep calling each other in a loop.
+
+## [0.22.9] - 2022-01-06
+
+### Added
+
+- Added `rss` integration (replaces the cumbersome and deprecated `backend.http.poll`).
+
+### Fixed
+
+- Fixed timezone handling in calendar integrations.
+- Fixed handling of ignored directories in the `file.monitor` backend.
+
+## [0.22.8] - 2021-12-13
+
+### Added
+
+- Added support for audio tracks in Plex integration.
+
+### Changed
+
+- Web server uWSGI wrapper changed from `uwsgi` to `gunicorn`.
+
+### Fixed
+
+- Fixed client ID assignment logic in MQTT backends to prevent client ID clashes and reconnections
+  (closes #205).
+- Updated LTR559 integration to be compatible with the new API.
+- Updated Chromecast integration to be compatible with `pychromecast >= 10`.
+- Better handling of media errors.
+
+## [0.22.6] - 2021-11-27
+
+### Added
+
+- Added support for converting webpages to markdown in `http.webpage.simplify`
+  even if no `outfile` is specified.
+
+### Fixed
+
+- Improved robustness of the ICal calendar parser in case some fields (e.g. `*status`)
+  are not defined.
+
+## [0.22.5] - 2021-11-15
+
+### Added
+
+- Added `mastodon` plugin.
+- Added `chat.irc` plugin.
+- Added `mailgun` plugin.
+
+### Fixed
+
+- Fixed `switchbot.status` method in case of virtual devices.
+- Fixed `platypush[alexa]` optional package installation.
+
+## [0.22.4] - 2021-10-19
+
+### Added
+
+- Support for IR virtual devices in Switchbot plugin.
+- Added [`google.maps.get_travel_time`](https://docs.platypush.tech/platypush/plugins/google.maps.html#platypush.plugins.google.maps.GoogleMapsPlugin.get_travel_time)
+  method (closes #115).
+- Support for custom YouTube video/audio formats on media plugins.
+
+### Fixed
+
+- Responses for requests received over an MQTT backend are now delivered to the right topic
+  (`<device_base_topic>/responses/<msg_id>`).
+- Various fixes on media plugins.
+
+## [0.22.3] - 2021-10-01
+
+### Added
+
+- `gotify` integration (see #198).
+
+## [0.22.2] - 2021-09-25
+
+### Added
+
+- `ngrok` integration (see #196).
+
+## [0.22.1] - 2021-09-22
+
+### Fixed
+
+- `zigbee.mqtt` backend now no longer requires the MQTT backend/plugin to be enabled.
+
+- Fixed bug on empty popcorn API responses.
+
+### Changed
+
+- Created CI Gitlab pipeline to replace the Platypush event-based pre-existing pipeline.
+
+### Removed
+
+- Removed docs references to removed/abstract integrations.
+
+## [0.22.0] - 2021-09-16
+
+### Changed
+
+- Platypush now uses manifest files to describe plugins and backends. Each extension is now
+  expected to provide a `manifest.yaml` file in its folder, reporting its package name, pip
+  dependencies, required system packages and optional extra installation commands.
+
+- Refactored `platyvenv`, `platydock`, documentation generation and plugin management engine.
+  They are now both faster and more robust, since they can rely on the manifest definition to
+  operate instead of pydoc strings conventions or `config.yaml` conventions.
+
+- `platyvenv start`  now starts the environment process synchronously and it prints
+  stdout/stderr instead of redirecting it to the logs dir (previous behaviour:
+  `platyvenv start` used to start the process asynchronously and the logs were stored
+  to `~/.local/share/platypush/venv/<env>/logs/<stdout|stderr>.log`).
+
+### Removed
+
+- Removed `Homeseer` integration - it was based on a Python integration that has now been
+  pulled out of PyPI and GitHub. A new integration may come in the future if there is enough
+  demand for it.
+
+## [0.21.4] - 2021-08-24
+
+### Fixed
+
+- Fixed JWT token generation, since python-jwt >= 2.0 always returns strings (not bytes) upon `jwt.encode`.
+
+## [0.21.3] - 2021-07-28
+
+### Added
+
+- Added `sun` plugin for sunrise/sunset events.
+
+- Added `slack` integration.
+
+## [0.21.2] - 2021-07-20
+
+### Added
+
+- Added `music.spotify` backend to emulate a Spotify Connect receiver through Platypush.
+
+- Added `music.spotify` plugin.
+
+- Added `music.spotify` UI integration.
+
+## [0.21.1] - 2021-06-22
+
+### Added
+
+- Added `switchbot` plugin to interact with Switchbot devices over the cloud API instead of
+  directly accessing the device's Bluetooth interface.
+
+- Added `marshmallow` dependency - it will be used from now own to dump and document schemas
+  and responses instead of the currently mixed approach with `Response` objects and plain
+  dictionaries and lists.
+
+- Support for custom MQTT timeout on all the `zwavejs2mqtt` calls.
+
+- Added generic joystick backend `backend.joystick.jstest` which uses `jstest` from the
+  standard `joystick` system package to read the state of joysticks not compatible with
+  `python-inputs`.
+
+- Added PWM PCA9685 plugin.
+
+- Added Linux native joystick plugin, ``backend.joystick.linux``, for the cases where
+  ``python-inputs`` doesn't work and ``jstest`` is too slow.
+
+### Changed
+
+- `switch.switchbot` plugin renamed to `switchbot.bluetooth` plugin, while the new plugin
+  that uses the Switchbot API is simply named `switchbot`.
+
+### Fixed
+
+- More robust reconnection logic on the Pushbullet backend in case of websocket errors.
+
+## [0.21.0] - 2021-05-06
+
+### Added
+
+- Support for custom PopcornTime API mirror/base URL.
+
+- Full support for TV series search.
+
+### Fixed
+
+- Fixed torrent search (now using a different PopcornTime API mirror).
+
+- Migrated SASS engine from `node-sass` (currently deprecated and broken on Node 16) to `sass`.
+
+- Fixed alignment of Z-Wave UI header on Chrome/Webkit.
+
+## [0.20.10] - 2021-04-28
+
+### Fixed
+
+- Fixed zwave/zwavejs2mqtt interoperability.
+
+## [0.20.9] - 2021-04-12
+
+### Added
+
+- Added zwavejs2mqtt integration (see [#186](https://git.platypush.tech/platypush/platypush/-/issues/186).
+
+### Fixed
+
+- Major LINT fixes.
+
+### Removed
+
+- Removed unmaintained integrations: TorrentCast and Booking.com
+
+## [0.20.8] - 2021-04-04
+
+### Added
+
+- Added `<Camera>` dashboard widget.
+
+- Added support for custom dashboard widgets with customized (see https://git.platypush.tech/platypush/platypush/wiki/Backends#creating-custom-widgets).
+
+- Added support for controls on `music.mpd` dashboard widget.
+
+### Fixed
+
+- Fixed zigbee2mqtt backend error in case of messages with empty payload (see [#184](https://git.platypush.tech/platypush/platypush/-/issues/184)).
+
+- Fixed compatibility with all versions of websocket-client - versions >= 0.58.0 pass a `WebSocketApp` object as a first
+  argument to the callbacks, as well as versions < 0.54.0 do, but the versions in between don't pass this argument.
+
+## [0.20.7] - 2021-03-26
+
+### Fixed
+
+- Fixed race condition on `media.vlc.stop` when clearing the VLC instance.
+
+- Fixed dashboard widgets custom classes being propagated both to the container and to the widget content [see #179]
+
+- Fixed compatibility with SQLAlchemy >= 1.4.
+
+## [0.20.6] - 2021-03-16
+
+### Added
+
+- Added `log.http` backend to monitor changes to HTTP log files
+  (see [#167](https://git.platypush.tech/platypush/platypush/-/issues/167)).
+
+- Added `file.monitor` backend, which replaces the `inotify` backend
+  (see [#172](https://git.platypush.tech/platypush/platypush/-/issues/172)).
+
+### Removed
+
+- Removed legacy `pusher` script and `local` backend.
+
+### Fixed
+
+- Fixed support for Z-Wave switches.
+
+- Fixed possible race condition on VLC stop.
+
+## [0.20.5] - 2021-03-12
+
+### Added
+
+- Added support for a static list of devices to actively scan to the `bluetooth.scanner` backend
+  (see [#174](https://git.platypush.tech/platypush/platypush/-/issues/174)).
+
+- Added `weather.openweathermap` plugin and backend, which replaces `weather.darksky`, since the
+  Darksky API will be completely shut down by the end of 2021.
+
+### Fixed
+
+- Cron expressions should adhere to the UNIX cronjob standard and use the machine local time,
+  not UTC, as a reference (closes [#173](https://git.platypush.tech/platypush/platypush/-/issues/173)).
+
+- Better management of Z-Wave values types from the UI.
+
+- Disable logging for `ZwaveValueEvent` events - they tend to be very verbose and
+  can impact the performance on slower devices. They will still be published to the
+  websocket clients though, so you can still debug Z-Wave values issues from the browser
+  developer console (enable debug traces).
+
+- Added suffix to the `zigbee.mqtt` backend default `client_id` to prevent clashes with
+  the default `mqtt` backend `client_id`.
+
+## [0.20.4] - 2021-03-08
+
+### Added
+
+- Added SmartThings integration.
+- Support for custom Redis message queue name over the `--redis-queue` argument.
+
+### Fixed
+
+- Refactored tests to use `pytest` instead of `unittest`.
+- Some major bug fixes on procedures and hooks context evaluation.
+
+## [0.20.3] - 2021-02-28
+
+### Fixed
+
+- Several bug fixes on the VLC plugin, including proper management of stop/end-of-stream, volume set and missing integration requirements in `requirements.txt` and `setup.py`.
+
+## [0.20.2] - 2021-02-27
+
+### Fixed
+
+- More stable ZeroConf backends registration logic in case of partial or missing results.
+- Improved and refactored integration tests.
+
+### Added
+
+- Support for passing context variables (${}) from YAML procedures/hooks/crons to Python procedure/hooks/crons.
+- New integration test for testing procedures.

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+Thanks for considering contributing your work to make Platypush a better product!
+
+Contributions are more than welcome, and the follow the standard Gitlab procedure:
+
+- [Fork the repo](https://git.platypush.tech/platypush/platypush).
+- Prepare your changes.
+- [Submit a merge request](https://git.platypush.tech/platypush/platypush/-/merge_requests).
+
+Guidelines:
+
+- The code should ideally have no LINT warnings/issues.
+
+- Project conventions:
+  - 4 spaces to indent.
+  - RST format for classes and methods documentation 
+  - Run `python generate_missing_docs.py` if you are adding new plugins/backends to automatically
+    generate the doc templates. Make sure that you don't accidentally remove lines elements from
+    the docs because of missing dependencies on the machine you use to generate the docs.
+  - Naming conventions: plugin classes are named `<Module>Plugin` and backend classes are
+    named `<Module>Backend`, with `<Module>` being the (camel-case) representation of the
+    Python module of the plugin without the prefix - for example, the plugin under
+    `platypush.plugins.light.hue` must be named `LightHuePlugin`.
+
+- If possible, [add a test](https://git.platypush.tech/platypush/platypush/-/tree/master/tests)
+  for the new functionality. If you have built a new functionality that works with some specific
+  device or service then it's not required to write a test that mocks the whole service, but if
+  you are changing some of the core entities (e.g. requests, events, procedures, hooks, crons
+  or the bus) then make sure to add tests and not to break the existing tests.
+
+- If the feature requires an optional dependency then make sure to document it
+  in the `manifest.json` - refer to the Wiki (how to write
+  [plugins](https://git.platypush.tech/platypush/platypush/wiki/Writing-your-own-plugins)
+  and
+  [backends](https://git.platypush.tech/platypush/platypush/wiki/Writing-your-own-backends))
+  for examples on how to write an extension manifest file.

Dockerfile

@@ -1,22 +0,0 @@
-# Sample Dockerfile. Use platydock -c /path/to/custom/config.yamlr
-# to generate your custom Dockerfile.
-
-
-FROM python:alpine3.7
-
-RUN mkdir /app
-COPY . /app
-WORKDIR /app
-RUN apk add --update --no-cache --virtual build-base \
-        && apk add --update --no-cache libffi-dev \
-        && apk add --update --no-cache zlib-dev \
-        && apk add --update --no-cache libjpeg-turbo-dev \
-        && pip install -r requirements.txt \
-        && apk del build-base \
-        && apk del libffi-dev \
-        && apk del libjpeg-turbo-dev \
-        && apk del zlib-dev
-
-RUN cd /app && python setup.py build install
-CMD python -m platypush
-

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017, 2018 Fabio Manganiello
+Copyright (c) 2017, 2020 Fabio Manganiello
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -1,3 +1,6 @@
-recursive-include platypush/backend/http/static *
-recursive-include platypush/backend/http/templates *
+recursive-include platypush/backend/http/webapp/dist *
+recursive-include platypush/install *
 include platypush/plugins/http/webpage/mercury-parser.js
+include platypush/config/*.yaml
+global-include manifest.json
+global-include components.json.gz

README.md

@@ -1,68 +1,832 @@
 Platypush
 =========
 
-[![Build Status](https://travis-ci.org/BlackLight/platypush.svg?branch=master)](https://travis-ci.org/BlackLight/platypush)
-[![Documentation Status](https://readthedocs.org/projects/platypush/badge/?version=latest)](https://platypush.readthedocs.io/en/latest/?badge=latest)
+[![Build Status](https://ci-cd.platypush.tech/api/badges/platypush/platypush/status.svg)](https://ci-cd.platypush.tech/platypush/platypush)
 [![pip version](https://img.shields.io/pypi/v/platypush.svg?style=flat)](https://pypi.python.org/pypi/platypush/)
+[![License](https://img.shields.io/github/license/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/src/branch/master/LICENSE.txt)
+[![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/commits/branch/master)
+[![Join chat on Matrix](https://img.shields.io/matrix/:platypush?server_fqdn=matrix.platypush.tech)](https://matrix.to/#/#platypush:matrix.platypush.tech)
+[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://git.platypush.tech/platypush/platypush/src/branch/master/CONTRIBUTING.md)
 
-Advised read: [**Getting started with Platypush**](https://medium.com/@automationguru/automate-your-house-your-life-and-everything-else-around-with-platypush-dba1cd13e3f6) (Medium article).
-[Reddit channel](https://www.reddit.com/r/platypush)
+<!-- toc -->
 
-Imagine Platypush as some kind of [IFTTT](https://ifttt.com) on steroids - or [Tasker](https://tasker.joaoapps.com/), or [Microsoft Flow](https://flow.microsoft.com), or [PushBullet](https://pushbullet.com) on steroids.
-Platypush aims to turn any device in a smart hub that can control things, interact with cloud services and send messages to other devices. It's a general-purpose lightweight platform to process any request and run any logic triggered by custom events.
+- [Introduction](#introduction)
+    + [What it can do](#what-it-can-do)
+- [Installation](#installation)
+  * [Prerequisites](#prerequisites)
+    + [Docker installation](#docker-installation)
+    + [Use an external service](#use-an-external-service)
+    + [Manual installation](#manual-installation)
+  * [Install through `pip`](#install-through-pip)
+  * [Install through a system package manager](#install-through-a-system-package-manager)
+  * [Install from sources](#install-from-sources)
+  * [Installing the dependencies for your extensions](#installing-the-dependencies-for-your-extensions)
+    + [Install via `extras` name](#install-via-extras-name)
+    + [Install via `manifest.json`](#install-via-manifestjson)
+    + [Check the instructions reported in the documentation](#check-the-instructions-reported-in-the-documentation)
+  * [Virtual environment installation](#virtual-environment-installation)
+  * [Docker installation](#docker-installation-1)
+- [Architecture](#architecture)
+  * [Plugins](#plugins)
+  * [Actions](#actions)
+  * [Backends](#backends)
+  * [Events](#events)
+  * [Hooks](#hooks)
+    + [More complex filters](#more-complex-filters)
+  * [Procedures](#procedures)
+  * [Cronjobs](#cronjobs)
+  * [Entities](#entities)
+  * [The web interface](#the-web-interface)
+    + [The main web panel](#the-main-web-panel)
+    + [The execution panel](#the-execution-panel)
+    + [Other web panels](#other-web-panels)
+    + [Dashboards](#dashboards)
+  * [Running in production mode](#running-in-production-mode)
+    + [PWA support](#pwa-support)
+- [Mobile app](#mobile-app)
+- [Tests](#tests)
+- [Useful links](#useful-links)
+- [Funding](#funding)
 
-Imagine the ability of running any task you like, or automate any routine you like, on any of your devices. And the flexibility of executing actions through a cloud service, with the power of running them from your laptop, Raspberry Pi, smart home device or smartphone.
+<!-- tocstop -->
+
+## Introduction
+
+Platypush is a general-purpose extensible platform for automation across
+multiple services and devices.
+
+It enables users to create their own self-hosted pieces of automation based on
+events (*if this happens then do that*)
+and it provides a comprehensive and customizable user interface that collects
+everything you need to visualize and control under one roof.
+
+It takes some concepts from [IFTTT](https://ifttt.com),
+[Tasker](https://tasker.joaoapps.com/), [Microsoft
+Flow](https://flow.microsoft.com) and [Home
+Assistant](https://www.home-assistant.io/) to provide an environment where the
+user can easily connect things together.
+
+It's built with compatibility and flexibility in mind, and it can easily run on
+any device that can run a Python interpreter - from a Raspberry Pi zero, to an
+old smartphone, to a beefy server.
+
+#### What it can do
 
 You can use Platypush to do things like:
 
-- Control your smart home lights
-- Control your favourite music player
-- Interact with your voice assistant
-- Get events from your Google or Facebook calendars
-- Read data from your sensors and trigger custom events whenever they go above or below some custom thresholds
-- Control the motors of your robot
-- Send automated emails
-- Synchronize the clipboards on your devices
-- Control your smart switches
-- Implement custom text-to-speech commands
-- Build any kind of interaction with your Android device using Tasker
-- Play local videos, YouTube videos and torrent links
-- Get weather forecast for your location
-- Build your own web dashboard with calendar, weather, news and music controls (basically, anything that has a Platypush web widget)
-- ...and much more (basically, anything that comes with a [Platypush plugin](https://platypush.readthedocs.io/en/latest/plugins.html))
+- [Control your smart home lights](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush)
+- [Control your music and synchronize it to multiple devices](https://blog.platypush.tech/article/Build-your-open-source-multi-room-and-multi-provider-sound-server-with-Platypush-Mopidy-and-Snapcast)
+- [Create custom and privacy-secure voice assistants that run custom hooks on your phrases](https://blog.platypush.tech/article/Build-custom-voice-assistants)
+- Build integrations between [sensors](https://docs.platypush.tech/en/latest/platypush/backend/sensor.html),
+  [cameras](https://docs.platypush.tech/en/latest/platypush/plugins/camera.pi.html),
+  [microphones](https://docs.platypush.tech/en/latest/platypush/plugins/sound.html)
+  and [machine learning
+  models](https://docs.platypush.tech/en/latest/platypush/plugins/tensorflow.html)
+  to create smart
+  pieces of automation for e.g.
+  [people detection](https://blog.platypush.tech/article/Detect-people-with-a-RaspberryPi-a-thermal-camera-Platypush-and-a-pinch-of-machine-learning)
+  or [sound detection](https://blog.platypush.tech/article/Create-your-smart-baby-monitor-with-Platypush-and-Tensorflow)
+- [Get events from your Google or Facebook calendars](https://docs.platypush.tech/en/latest/platypush/plugins/calendar.html)
+- [Read data from your sensors and trigger custom events whenever they go above or below some custom thresholds](https://blog.platypush.tech/article/How-to-build-your-personal-infrastructure-for-data-collection-and-visualization)
+- [Control and automate a self-built robot](https://docs.platypush.tech/en/latest/platypush/plugins/gpio.zeroborg.html)
+- [Deliver automated newsletters from custom RSS digests](https://blog.platypush.tech/article/Deliver-customized-newsletters-from-RSS-feeds-with-Platypush)
+- [Synchronize the clipboards on your devices](https://docs.platypush.tech/en/latest/platypush/plugins/clipboard.html)
+- [Control your smart switches](https://docs.platypush.tech/en/latest/platypush/plugins/switch.html)
+- [Implement automated custom text-to-speech routines](https://docs.platypush.tech/en/latest/platypush/plugins/tts.html)
+- [Build any kind of interactions and automation routines with your Android device using Tasker](https://blog.platypush.tech/article/How-to-build-your-personal-infrastructure-for-data-collection-and-visualization)
+- Play [local
+  videos](https://docs.platypush.tech/en/latest/platypush/plugins/media.mpv.html),
+  YouTube videos and torrent media from any device and service, to any device
+- [Get weather forecast events for your location and build automation routines on them](https://docs.platypush.tech/en/latest/platypush/plugins/weather.darksky.html)
+- [Create a custom single hub for Zigbee and Z-Wave smart devices](https://blog.platypush.tech/article/Transform-a-RaspberryPi-into-a-universal-Zigbee-and-Z-Wave-bridge)
+- Build your own web dashboard with calendar, weather, news and music controls
+  (basically, anything that has a Platypush web widget)
+- ...and much more (basically, anything that comes with a [Platypush plugin](https://docs.platypush.tech))
 
-Imagine the ability of executing all the actions above through messages delivered through:
+## Installation
 
-- A web interface
-- A JSON-RPC API
-- Raw TCP messages
-- Web sockets
-- [PushBullet](https://pushbullet.com)
-- [Kafka](https://kafka.apache.org)
-- [Redis](https://redis.io)
-- [MQTT](https://mqtt.org)
-- ...amd much more (basically, anything that comes with a [Platypush backend](https://platypush.readthedocs.io/en/latest/backends.html))
+### Prerequisites
 
-Imagine the ability of building custom event hooks to automatically trigger any actions:
+Platypush uses [Redis](https://redis.io/) to dispatch requests, responses,
+events and custom messages across several processes and integrations.
 
-- When your voice assistant recognizes some text
-- When you start playing a new song
-- When a new event is added to your calendar
-- When a new article is published on your favourite feed
-- When the weather conditions change
-- When your press a [Flic button](https://flic.io) with a certain pattern
-- When you receive a new push on your Pushbullet account
-- When your GPS signal enters a certain area
-- Whenever a new MIDI event is received (yes, you heard well :) )
-- Whenever a sensor sends new data
-- At a specific date or time
-- ...and so on (basically, anything can send events that can be used to build hooks)
+#### Docker installation
 
-Imagine the ability of running the application, with lots of those bundled features, on any device that can comes with Python (_only compatible with version 3.5 and higher_). Platypush has been designed with performance in mind, it's been heavily tested on slower devices like Raspberry Pis, and it can run the web server features, multiple backends and plugins quite well even on a Raspberry Pi Zero - it's even been tested with some quite impressive performance on an older [Nokia N900](https://en.wikipedia.org/wiki/Nokia_N900), and of course you can run it on any laptop, desktop, server environment. It's been developed mainly with IoT in mind (and some of its features overlap with IoT frameworks like [Mozilla IoT](https://iot.mozilla.com) and [Android Things](https://developer.android.com/things/)), but nothing prevents you from automating any task on any device and environment.
+You can run Redis on the fly on your local machine using a Docker image:
 
-To get started:
+```bash
+# Expose a Redis server on port 6379 (default)
+docker run --rm -p 6379:6379 --name redis redis
+```
 
-- [Wiki](https://github.com/BlackLight/platypush/wiki) for installation notes, quick start, examples and architecture reference
-- [Read the docs](https://platypush.readthedocs.io/en/latest/) for a complete reference on the available plugins and backends
-- [Medium articles](https://medium.com/tag/platypush/archive) that describe hands-on applications of platypush
+#### Use an external service
 
+You can let Platypush use an external Redis service, if you wish to avoid
+running one on the same machine.
+
+In such scenario, simply start the application by passing custom values for
+`--redis-host` and `--redis-port`, or configure these values in its
+configuration file:
+
+```yaml
+redis:
+  host: some-ip
+  port: some-port
+```
+
+If you wish to run multiple instances that use the same Redis server, you may
+also want to customize the name of the default queue that they use
+(`--redis-queue` command-line option) in order to avoid conflicts.
+
+#### Manual installation
+
+Unless you are running Platypush in a Docker container, or you are running
+Redis in a Docker container, or you want to use a remote Redis service, the
+Redis server should be installed on the same machine where Platypush runs:
+
+```bash
+# On Debian-based distributions
+sudo apt install redis-server
+
+# On Arch-based distributions
+# The hiredis package is also advised
+sudo pacman -S redis
+
+# On MacOS
+brew install redis
+```
+
+Once Redis is installed, you have two options:
+
+1. Run it a separate service. This depends on your operating system and
+   supervisor/service controller. For example, on systemd:
+
+```bash
+# Enable and start the service
+sudo systemctl enable redis
+sudo systemctl start redis
+```
+
+2. Let Platypush run and control the Redis service. This is a good option if
+   you want Platypush to run its own service, separate from any other one
+   running on the same machine, and terminate it as soon as the application
+   ends. In this case, simply launch the application with the `--start-redis`
+   option (and optionally `--redis-port <any-num>` to customize the listen
+   port).
+
+### Install through `pip`
+
+```bash
+[sudo] pip install platypush
+```
+
+### Install through a system package manager
+
+Note: currently only Arch Linux and derived distributions are supported.
+
+You can either install the
+[`platypush`](https://aur.archlinux.org/packages/platypush) package (for the
+latest stable version) or the
+[`platypush-git`](https://aur.archlinux.org/packages/platypush-git) package
+(for the latest git version) through your favourite AUR package manager. For
+example, using `yay`:
+
+```bash
+yay platypush
+# Or
+yay platypush-git
+```
+
+The Arch Linux packages on AUR are automatically updated upon new git commits
+or tags.
+
+### Install from sources
+
+```shell
+git clone https://git.platypush.tech/platypush/platypush.git
+cd platypush
+[sudo] pip install .
+```
+
+### Installing the dependencies for your extensions
+
+After installing the base platform, you may want to check the dependencies and
+configuration required by the extensions that you wish to use. There are a few
+ways to check the dependencies required by an extension:
+
+#### Install via `extras` name
+
+You can install extra dependencies via pip extras:
+
+```shell
+pip install 'platypush[plugin1,plugin2,...]'
+```
+
+For example:
+
+```shell
+pip install 'platypush[light.hue,music.mpd,rss]'
+```
+
+Will install Platypush with the dependencies for the `light.hue`, `music.mpd`
+and `rss` plugins.
+
+#### Install via `manifest.json`
+
+All the plugins and backends have a `manifest.json` file in their source folder.
+Any extra dependencies are listed there
+
+If you followed the `extras` or `manifest.json` way to discover the
+dependencies, then you can install them in two ways:
+
+1. `pip` installation:
+
+```shell
+[sudo] pip3 install 'platypush[extra1,extra2,extra3]'
+```
+
+2. Sources installation:
+
+```shell
+cd $DIR_TO_PLATYPUSH
+[sudo] pip3 install '.[extra1,extra2,extra3]'
+```
+
+#### Check the instructions reported in the documentation
+
+If you follow this route then simply run the commands listed in the
+[plugin/backend documentation](https://docs.platypush.tech) to get the
+dependencies installed.
+
+After installing the dependencies, create a configuration file under
+`~/.config/platypush/config.yaml` (the application can load the configuration
+from another location through the `-c` option) containing the configuration of
+the backend and plugins that you want to use, and add any hooks and procedures
+for your use case.
+
+You can then start the service by simply running:
+
+```shell
+platypush
+```
+
+See `platypush --help` for a full list of options.
+
+It's advised to run it as a systemd service though - simply copy the provided
+[`.service`
+file](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/systemd/platypush.service)
+to `~/.config/systemd/user`, check if the path of `platypush` matches the path
+where it's installed on your system, and start the service via `systemctl`:
+
+```shell
+systemctl --user start platypush
+```
+
+### Virtual environment installation
+
+Platypush provides a script named `platyvenv` that can parse a `config.yaml`
+and automatically create a virtual environment (under
+`~/.local/share/platypush/venv/<device_id>`) with all the dependencies required
+by the configured integrations.
+
+1. Create the environment from a configuration file:
+
+    ```shell
+    platyvenv build -c /path/to/config.yaml
+    ```
+
+2. Start the service from the virtual environment:
+
+    ```shell
+    # device_id matches either the hostname or the device_id in config.yaml
+    platyvenv start device_id
+    ```
+
+3. Stop the instance:
+
+    ```shell
+    platyvenv stop device_id
+    ```
+
+4. Remove the instance:
+
+    ```shell
+    platyvenv rm device_id
+    ```
+
+[Wiki instructions](https://git.platypush.tech/platypush/platypush/wiki/Run-platypush-in-a-virtual-environment)
+
+### Docker installation
+
+You can also install Platypush in a container - the application provides a
+script named `platydock` that automatically creates a container instance from a
+`config.yaml`:
+
+1. Create the container from a configuration file:
+
+    ```shell
+    platydock build -c /path/to/config.yaml
+    ```
+
+2. Start the container:
+
+    ```shell
+    # device_id matches either the hostname or the device_id in config.yaml
+    platydock start device_id
+    ```
+
+3. Stop the instance:
+
+    ```shell
+    platydock stop device_id
+    ```
+
+4. Remove the instance:
+
+    ```shell
+    platydock rm device_id
+    ```
+
+Note that both the virtual environment and Docker container option offer the
+possibility to include extra YAML configuration files in the main `config.yaml`
+through the `include` directive (as long as they are in the same folder as the
+main `config.yaml`), as well as external Python scripts in a `scripts`
+directory in the same folder as the `config.yaml`.
+
+[Wiki instructions](https://git.platypush.tech/platypush/platypush/wiki/Run-platypush-in-a-container)
+
+## Architecture
+
+The architecture of Platypush consists of a few simple pieces, orchestrated by
+a configuration file stored by default under
+[`~/.config/platypush/config.yaml`](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/conf/config.yaml):
+
+### Plugins
+
+[Full list](https://docs.platypush.tech/en/latest/plugins.html)
+
+Plugins are integrations that do things - like [modify
+files](https://docs.platypush.tech/en/latest/platypush/plugins/file.html),
+[train and evaluate machine learning
+models](https://docs.platypush.tech/en/latest/platypush/plugins/tensorflow.html),
+[control
+cameras](https://docs.platypush.tech/en/latest/platypush/plugins/camera.pi.html),
+[read
+sensors](https://docs.platypush.tech/en/latest/platypush/plugins/gpio.sensor.dht.html),
+[parse a web
+page](https://docs.platypush.tech/en/latest/platypush/plugins/http.webpage.html),
+[control
+lights](https://docs.platypush.tech/en/latest/platypush/plugins/light.hue.html),
+[send
+emails](https://docs.platypush.tech/en/latest/platypush/plugins/mail.smtp.html),
+[control
+Chromecasts](https://docs.platypush.tech/en/latest/platypush/plugins/media.chromecast.html),
+[run voice
+queries](https://docs.platypush.tech/en/latest/platypush/plugins/assistant.google.html),
+[handle torrent
+transfers](https://docs.platypush.tech/en/latest/platypush/plugins/torrent.html)
+or control
+[Zigbee](https://docs.platypush.tech/en/latest/platypush/plugins/zigbee.mqtt.html)
+or [Z-Wave](https://docs.platypush.tech/en/latest/platypush/plugins/zwave.html)
+devices.
+
+The configuration of a plugin matches one-on-one that of its documented class
+constructor, so it's very straightforward to write a configuration for a plugin
+by reading its documentation:
+
+```yaml
+light.hue:
+  # Groups that will be controlled by default
+  groups:
+    - Living Room
+    - Hall
+```
+
+### Actions
+
+Plugins expose *actions*, that match one-on-one the plugin class methods
+denoted by `@action`, so it's very straightforward to invoke plugin actions by
+just reading the plugin documentation. They can be invoked directly from your
+own scripts or they can be sent to the platform through any supported channel
+as simple JSON messages:
+
+```json
+{
+  "type": "request",
+  "action": "light.hue.on",
+  "args": {
+    "lights": ["Entrance Bulb"]
+  }
+}
+```
+
+### Backends
+
+[Full list](https://docs.platypush.tech/en/latest/backends.html)
+
+They are background services that listen for messages on channels (like
+an [HTTP
+backend](https://docs.platypush.tech/en/latest/platypush/backend/http.html), an
+[MQTT
+instance](https://docs.platypush.tech/en/latest/platypush/backend/mqtt.html), a
+[Kafka
+instance](https://docs.platypush.tech/en/latest/platypush/backend/kafka.html).
+
+If a backend supports the execution of requests (e.g. HTTP, MQTT, Kafka,
+Websocket and TCP) then you can send requests to these services in JSON format.
+For example, in the case of the HTTP backend:
+
+```shell
+# Get a token
+curl -XPOST -H 'Content-Type: application/json' -d '
+{
+  "username": "$YOUR_USER",
+  "password": "$YOUR_PASSWORD"
+}' http://host:8008/auth
+
+# Execute a request
+curl -XPOST -H 'Content-Type: application/json' \
+    -H "Authorization: Bearer $YOUR_TOKEN" -d '
+{
+  "type": "request",
+  "action": "tts.say",
+  "args": {
+    "text": "This is a test"
+  }
+}' http://host:8008/execute
+```
+
+### Events
+
+[Full list](https://docs.platypush.tech/en/latest/events.html)
+
+When a certain event occurs (e.g. a JSON request is received, or a [Bluetooth
+device is
+connected](https://docs.platypush.tech/en/latest/platypush/events/bluetooth.html#platypush.message.event.bluetooth.BluetoothDeviceConnectedEvent),
+or a [Flic button is
+pressed](https://docs.platypush.tech/en/latest/platypush/events/button.flic.html#platypush.message.event.button.flic.FlicButtonEvent),
+or some [speech is detected on the voice assistant
+service](https://docs.platypush.tech/en/latest/platypush/events/assistant.html#platypush.message.event.assistant.SpeechRecognizedEvent),
+or an [RSS feed has new
+items](https://docs.platypush.tech/en/latest/platypush/events/http.rss.html#platypush.message.event.http.rss.NewFeedEvent),
+or a [new email is
+received](https://docs.platypush.tech/en/latest/platypush/events/mail.html#platypush.message.event.mail.MailReceivedEvent),
+or a [new track is
+played](https://docs.platypush.tech/en/latest/platypush/events/music.html#platypush.message.event.music.NewPlayingTrackEvent),
+or an [NFC tag is
+detected](https://docs.platypush.tech/en/latest/platypush/events/nfc.html#platypush.message.event.nfc.NFCTagDetectedEvent),
+or [new sensor data is
+available](https://docs.platypush.tech/en/latest/platypush/events/sensor.html#platypush.message.event.sensor.SensorDataChangeEvent),
+or [a value of a Zigbee device
+changes](https://docs.platypush.tech/en/latest/platypush/events/zigbee.mqtt.html#platypush.message.event.zigbee.mqtt.ZigbeeMqttDevicePropertySetEvent),
+etc.), the associated backend will trigger an
+[event](https://docs.platypush.tech/en/latest/events.html).
+
+### Hooks
+
+Event hooks are custom pieces of logic that will be run when a certain event is
+triggered. Hooks are the glue that connects events to actions, exposing a
+paradigm similar to IFTTT (_if a certain event happens then run these
+actions_). They can declared as:
+
+- Sections of the [`config.yaml`](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/conf/config.yaml).
+  Example:
+
+```yaml
+event.hook.SearchSongVoiceCommand:
+  if:
+    type: platypush.message.event.assistant.SpeechRecognizedEvent
+    phrase: "play ${title} by ${artist}"
+  then:
+    - action: music.mpd.clear
+    - action: music.mpd.search
+      args:
+        filter:
+          artist: ${artist}
+          title: ${title}
+
+    - if ${len(output)}:
+      - action: music.mpd.play
+        args:
+          resource: ${output[0]['file']}
+```
+
+- Stand-alone Python scripts stored under `~/.config/platypush/scripts` and
+  will be dynamically imported at start time.
+  [Example](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/conf/hook.py):
+
+```python
+from platypush import run, when
+from platypush.message.event.assistant import SpeechRecognizedEvent
+
+@when(SpeechRecognizedEvent, phrase='play ${title} by ${artist}')
+def on_music_play_command(event, title=None, artist=None, **context):
+  results = run('music.mpd.search', filter={
+    'artist': artist,
+    'title': title,
+  })
+
+  if results:
+    run('music.mpd.play', results[0]['file'])
+```
+
+#### More complex filters
+
+Your event hooks can include more complex filters too. Structured filters
+against partial event arguments are also possible, and relational operators are
+supported as well. For example:
+
+```python
+from platypush import when
+from platypush.message.event.sensor import SensorDataChangeEvent
+
+@when(SensorDataChangeEvent, data=1):
+def hook_1(event):
+    """
+    Triggered when event.data == 1
+    """
+
+@when(SensorDataChangeEvent, data={'state': 1}):
+def hook_2(event):
+    """
+    Triggered when event.data['state'] == 1
+    """
+
+@when(SensorDataChangeEvent, data={
+  'temperature': {'$gt': 25},
+  'humidity': {'$le': 15}
+}):
+def hook_3(event):
+    """
+    Triggered when event.data['temperature'] > 25 and
+    event.data['humidity'] <= 15.
+    """
+```
+
+The supported relational fields are the same supported by ElasticSearch - `$gt`
+for greater than, `$lt` for lesser than, `$ge` for greater or equal, `$ne` for
+not equal, etc.
+
+### Procedures
+
+Procedures are pieces of custom logic that can be executed as atomic actions
+using `procedure.<name>` as an action name.
+
+They can be defined either in the `config.yaml` or as Python scripts stored
+under `~/.config/platypush/scripts`.
+
+YAML example for a procedure that can be executed when we arrive home and turns
+on the lights if the luminosity is lower that a certain thresholds, says a
+welcome home message using the TTS engine and starts playing the music:
+
+```yaml
+procedure.at_home:
+    # Get luminosity data from a sensor - e.g. LTR559
+    - action: gpio.sensor.ltr559.get_data
+
+    # If it's lower than a certain threshold, turn on the lights
+    - if ${int(light or 0) < 110}:
+        - action: light.hue.on
+
+    # Say a welcome home message
+    - action: tts.google.say
+      args:
+        text: Welcome home
+
+    # Play the music
+    - action: music.mpd.play
+```
+
+Python example:
+
+```python
+# Content of ~/.config/platypush/scripts/home.py
+from platypush.procedure import procedure
+from platypush.utils import run
+
+@procedure
+def at_home(**context):
+  sensor_data = run('gpio.sensor.ltr559.get_data')
+  if sensor_data['light'] < 110:
+    run('light.hue.on')
+
+  run('tts.google.say', text='Welcome home')
+  run('music.mpd.play')
+```
+
+In either case, you can easily trigger the at-home procedure by sending an
+action request message to a backend - for example, over the HTTP backend:
+
+```shell
+curl -XPOST -H 'Content-Type: application/json' \
+    -H "Authorization: Bearer $YOUR_TOKEN" -d '
+{
+  "type": "request",
+  "action": "procedure.at_home"
+}' http://host:8008/execute
+```
+
+### Cronjobs
+
+Cronjobs are pieces of logic that will be run at regular intervals, expressed
+in crontab-compatible syntax. They can be defined either in the `config.yaml`
+or as Python scripts stored under `~/.config/platypush/scripts` as functions
+labelled by the `@cron` decorator.
+
+Note that seconds are also supported (unlike the standard crontab definition),
+but, for back-compatibility with the standard crontab format, they are at the
+end of the cron expression, so the expression is actually in the format
+`<minute> <hour> <day_of_month> <month> <day_of_week> <second>`.
+
+YAML example for a cronjob that is executed every 30 seconds and checks if a
+Bluetooth device is nearby:
+
+```yaml
+cron.check_bt_device:
+  cron_expression: '* * * * * */30'
+  actions:
+    - action: bluetooth.lookup_name
+      args:
+        addr: XX:XX:XX:XX:XX:XX
+
+    - if ${name}:
+        - action: procedure.on_device_on
+    - else:
+        - action: procedure.on_device_off
+```
+
+Python example:
+
+```python
+# Content of ~/.config/platypush/scripts/bt_cron.py
+from platypush.cron import cron
+from platypush.utils import run
+
+@cron('* * * * * */30')
+def check_bt_device(**context):
+  name = run('bluetooth.lookup_name').get('name')
+  if name:
+    # on_device_on logic here
+  else:
+    # on_device_off logic here
+```
+
+### Entities
+
+Entities are a fundamental building block of Platypush. Most of the
+integrations will store their state or connected devices in the form of
+entities - e.g. the sensors detected by the Z-Wave/Zigbee/Bluetooth
+integration, or the lights connected to a Hue bridge, or your cloud nodes, or
+your custom Arduino/ESP machinery, and so on.
+
+Entities provide a consistent interface to interact with your integrations
+regardless of their type and the plugin that handles them. For instance, all
+temperature sensors will expose the same interface, regardless if they are
+Bluetooth or Zigbee sensors, and all the media plugins will expose the same
+interface, regardless if they manage Chromecasts, Kodi, Plex, Jellyfin or a
+local VLC player.
+
+Once you enable the HTTP backend and a few integrations that export entities
+and register a user, you can query the detected entities via:
+
+```shell
+curl -XPOST -H 'Content-Type: application/json' \
+    -H "Authorization: Bearer $YOUR_TOKEN" \
+    -d '{"type":"request", "action":"entities.get"}' \
+    http://localhost:8008/execute
+```
+
+All the entities expose the same interface and can be manipulated through the
+same API. Also, when an entity is updated it always emits an
+[`EntityUpdateEvent`](https://docs.platypush.tech/platypush/events/entities.html#platypush.message.event.entities.EntityUpdateEvent),
+so you can easily create hooks that react to these events and act on multiple
+types of entities.
+
+### The web interface
+
+If
+[`backend.http`](https://docs.platypush.tech/en/latest/platypush/backend/http.html)
+is enabled then a web interface will be provided by default on
+`http://host:8008/`. Besides using the `/execute` endpoint for running
+requests, the built-in web server also provides a full-featured interface that
+groups together the controls for most of the plugins - e.g. sensors, switches,
+music controls and search, media library and torrent management, lights,
+Zigbee/Z-Wave devices and so on. The UI is responsive and mobile-friendly.
+
+#### The main web panel
+
+This is the default panel available at `http://<host>:<port>` after
+registration/login. It provides all the entities published by the integrations
+under one view, with custom grouping and filtering options.
+
+![Screenshot of the application main
+panel, showing the Bluetooth, Serial, SmartThings and System integrations](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/main-panel-screenshot-1.png)
+
+![Screenshot of the application main
+panel, showing the Philips Hue, Zigbee, SmartThings and some sensors integrations](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/main-panel-screenshot-2.png)
+
+#### The execution panel
+
+The web interface provides an `execute` panel as well. You can use this panel to
+interactively inspect the available integrations and their actions, together
+with their documentation and parameters, run requests directly from the web
+interface, and inspect the JSON responses.
+
+![Screenshot of the execution panel, showing the actions autocomplete
+form](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/execute-panel-screenshot-1.png)
+
+![Screenshot of the execution panel, showing an action's automatically generated
+documentation and its parsed attributes](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/execute-panel-screenshot-2.png)
+
+#### Other web panels
+
+Several integrations add their own feature-rich panels to the web view, turning
+Platypush into a gateway to all of your services - from Zigbee sensors, to media
+players and services, to your music cloud, and more.
+
+![Screenshot of the media panel, showing search results from multiple sources
+and several supported types of streaming services](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/media-panel-screenshot-1.png)
+
+![Screenshot of one of the music
+panels](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/music-panel-screenshot-1.png)
+
+![Screenshot of the Snapcast panel, which can be used to synchronize your music
+streams across multiple
+devices](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/snapcast-panel-screenshot-1.png)
+
+#### Dashboards
+
+The web service also provides means for the user to create [custom
+dashboards](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/conf/dashboard.xml)
+that can be used to show information from multiple sources on a large screen.
+
+![Screenshot of a Platypush dashboard, showing a calendar widget, the current
+music state, weather, news from the RSS integration, and a carousel of custom
+pictures.](https://blog.platypush.tech/img/dashboard-1.png)
+
+### Running in production mode
+
+If you want to access your Platypush web panel outside your home network, it may
+be a good idea to use an nginx/Apache reverse proxy with a valid SSL certificate
+(e.g. managed by certbot). A [sample an nginx
+configuration](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/nginx/nginx.sample.conf)
+is provided in the repository.
+
+#### PWA support
+
+Note that having the web application served over SSL is a requirement for the
+PWA (progressive web app) to work. The Platypush PWA allows you to install a
+Platypush native-like client on your mobile devices if you don't want to use the
+full Android app.
+
+## Mobile app
+
+An [official Android
+app](https://f-droid.org/en/packages/tech.platypush.platypush/) is provided on
+the F-Droid store. It allows to easily discover and manage multiple Platypush
+services on a network through the web interface, and it easily brings the power
+of Platypush to your fingertips.
+
+## Tests
+
+To run the tests simply run `pytest` either from the project root folder or the
+`tests/` folder.
+
+## Useful links
+- Recommended read: [**Getting started with Platypush**](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush).
+
+- The [blog](https://blog.platypush.tech) is a good place to get more insights
+  and inspiration on what you can build.
+
+- The [wiki](https://git.platypush.tech/platypush/platypush/wiki) also
+  contains many resources on getting started.
+
+- Extensive documentation for all the available integrations and messages [is
+  available](https://docs.platypush.tech/).
+
+- If you have issues/feature requests/enhancements please [create an
+  issue](https://git.platypush.tech/platypush/platypush/issues).
+
+- A [Matrix instance](https://matrix.to/#/#platypush:matrix.platypush.tech) is
+  available if you are looking for interactive support.
+
+- An IRC channel is also available at `#platypush@irc.platypush.tech:6697` (SSL
+  only).
+
+- A [Lemmy instance](https://lemmy.platypush.tech/c/platypush) is available for
+  general questions.
+
+---
+
+## Funding
+
+If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello).
+
+I've been working on Platypush all by myself in my spare time for the past few
+years, and I've made sure that it remains open and free.
+
+If you like this product, please consider supporting - I'm definitely not
+planning to get rich with this project, but I'd love to have at least the costs
+for the server covered by users.
+
+Issues and requests opened by donors will also be given priority over others.

bin/platypush

@@ -1,9 +0,0 @@
-#!python3
-
-from platypush import main
-
-if __name__ == '__main__':
-    main()
-
-
-# vim:sw=4:ts=4:et:

bin/platyvenv

@@ -1,259 +0,0 @@
-#!/bin/bash
-
-##############################################################################
-# This script allows you to easily manage Platypush instances through Python #
-# virtual environment. You can build environments from a config.yaml file    #
-# and automatically managed the required dependencies, as well as start,     #
-# stop and remove them                                                       #
-#                                                                            #
-# @author: Fabio Manganiello <blacklight86@gmail.com>                        #
-# @licence: MIT                                                              #
-##############################################################################
-
-
-workdir=$HOME/.local/share/platypush/venv
-
-function build {
-    cfgfile=
-
-    while getopts ':c:' opt; do
-        case ${opt} in
-            c)
-                cfgfile=$OPTARG;;
-            \?)
-                echo "Invalid option: -$OPTARG" >&2
-                exit 1;;
-            :)
-                echo "Option -$OPTARG requires the path to a Platypush configuration file" >&2
-                exit 1;;
-        esac
-    done
-
-    if [[ -z "$cfgfile" ]]; then
-        echo "Usage: $0 build -c <path-to-platypush-config-file>" >&2
-        exit 1
-    fi
-
-    echo "Parsing configuration file"
-    deps=()
-    includes=()
-
-    while read -r line; do
-        echo ${line} | egrep '``pip install .+?``' > /dev/null 2>&1
-        if (( $? != 0 )); then
-            continue
-        fi
-
-        dep=$(echo ${line} | sed -r -e 's/.*``pip install (.+?)``.*/\1/')
-        deps+=("$dep")
-    done <<< $(python <<EOF
-from platypush.config import Config
-from platypush.context import get_plugin, get_backend, register_backends
-
-Config.init('`realpath ${cfgfile}`')
-register_backends()
-backend_config = Config.get_backends()
-
-for name in Config.get_backends().keys():
-    backend = get_backend(name)
-    print(backend.__doc__)
-
-for name in Config.get_plugins().keys():
-    try:
-        plugin = get_plugin(name)
-        print(plugin.__doc__)
-    except:
-        pass
-EOF
-)
-
-    while read -r include; do
-        includes+=(${include})
-    done <<< $(python <<EOF
-from platypush.config import Config
-from platypush.context import get_plugin, get_backend, register_backends
-
-Config.init('`realpath ${cfgfile}`')
-
-for include in Config._included_files:
-    print(include)
-EOF
-)
-
-    device_id=$(python <<EOF
-from platypush.config import Config
-
-Config.init('`realpath ${cfgfile}`')
-print(Config.get('device_id'))
-EOF
-)
-
-    envdir=${workdir}/${device_id}
-    etcdir=${envdir}/etc/platypush
-
-    echo "Preparing virtual environment for device $device_id"
-    mkdir -p "$envdir"
-    mkdir -p "$etcdir"
-    srcdir=`dirname "$cfgfile"`
-
-    for ((i=0; $i < ${#includes[@]}; i++)); do
-        incdir=`dirname "${includes[$i]}"`
-        incdir=`realpath --relative-to="$srcdir" "$incdir"`
-        destdir="$etcdir/$incdir"
-        mkdir -p "$destdir"
-        cp "${includes[$i]}" "$destdir"
-    done
-
-    cp "$cfgfile" "$etcdir/config.yaml"
-    cfgfile=${etcdir}/config.yaml
-
-    python3 -m venv ${envdir}
-    cd ${envdir}
-    source ${envdir}/bin/activate
-
-    echo "Installing required dependencies"
-
-    for ((i=0; $i < ${#deps[@]}; i++)); do
-        echo ${deps[$i]}
-    done | sort -u | while read dep; do
-        pip install ${dep}
-    done
-
-    pip install --upgrade git+https://github.com/BlackLight/platypush.git
-    echo "Platypush virtual environment prepared under $envdir"
-}
-
-function start {
-    if [[ -z "$1" ]]; then
-        echo "Usage: $0 start <env-name>" >&2
-        exit 1
-    fi
-
-    env=$1
-    envdir=${workdir}/${env}
-    logsdir=${envdir}/var/log/platypush
-    rundir=${envdir}/var/run
-    pidfile=${rundir}/platypush.pid
-    cfgfile=${envdir}/etc/platypush/config.yaml
-
-    if [[ ! -d "$envdir" ]]; then
-        echo "No such directory: $envdir" >&2
-        exit 1
-    fi
-
-    mkdir -p ${logsdir}
-    mkdir -p ${rundir}
-
-    if [[ -f "$pidfile" ]]; then
-        pid=`cat "$pidfile"`
-        if ps -p ${pid} | grep platypush; then
-            echo "Another instance (PID $pid) is running, please stop that instance first"
-            exit 1
-        fi
-
-        echo "A PID file was found but the process doesn't seem to be running, starting anyway"
-        rm -f "$pidfile"
-    fi
-
-    python3 -m venv ${envdir}
-    cd ${envdir}
-    source bin/activate
-    bin/platypush -c "$cfgfile" -P "$pidfile" > ${logsdir}/stdout.log 2> ${logsdir}/stderr.log &
-    start_time=`date +'%s'`
-    timeout=30
-
-    while :; do
-        [[ -f "$pidfile" ]] && break
-        now=`date +'%s'`
-        let elapsed=$now-$start_time
-        if (( ${elapsed} >= ${timeout} )); then
-            echo "Platypush instance '$env' didn't start within $timeout seconds" >&2
-            exit 1
-        fi
-
-        echo -n '.'
-        sleep 1
-    done
-
-    pid=`cat "$pidfile"`
-    echo
-    echo "Platypush environment $env started with PID $pid, logs dir: $logsdir"
-}
-
-function stop {
-    if [[ -z "$1" ]]; then
-        echo "Usage: $0 stop <env-name>" >&2
-        exit 1
-    fi
-
-    env=$1
-    envdir=${workdir}/${env}
-    rundir=${envdir}/var/run
-    pidfile=${rundir}/platypush.pid
-
-    if [[ ! -d "$envdir" ]]; then
-        echo "No such directory: $envdir" >&2
-        exit 1
-    fi
-
-    if [[ ! -f "$pidfile" ]]; then
-        echo "No pidfile found for instance "${env}""
-        exit 1
-    fi
-
-    pid=`cat "$pidfile"`
-    pids="$pid `ps --no-headers -o pid= --ppid $pid`"
-    kill -9 ${pids}
-    rm -f "$pidfile"
-    echo "Instance '$env' with PID $pid stopped"
-}
-
-function rme {
-    if [[ -z "$1" ]]; then
-        echo "Usage: $0 rm <env-name>" >&2
-        exit 1
-    fi
-
-    envdir=${workdir}/$1
-    rundir=${envdir}/var/run
-    pidfile=${rundir}/platypush.pid
-
-    if [[ ! -d "$envdir" ]]; then
-        echo "No such directory: $envdir" >&2
-        exit 1
-    fi
-
-    if [[ -f "$pidfile" ]]; then
-        if ps -p `cat "$pidfile"` | grep platypush; then
-            echo "Another instance (PID $pidfile) is running, please stop that instance first"
-            exit 1
-        fi
-
-        echo "A PID file was found but the process doesn't seem to be running, removing anyway"
-    fi
-
-    rm -rf "$envdir"
-    echo "$envdir removed"
-}
-
-function usage {
-    echo "Usage: $0 <build|start|stop|rm> [options]" >&2
-    exit 1
-}
-
-if (( $# < 1 )); then
-    usage
-fi
-
-action=$1
-shift
-mkdir -p ${workdir}
-
-case ${action} in
-    'build') build;;
-    'start') start $*;;
-    'stop') stop $*;;
-    'rm') rme $*;;
-    *) usage;;
-esac
-

docs/README.md

@@ -0,0 +1,21 @@
+# Platypush self-generated reference
+====================================
+
+This directory contains the Sphinx self-generated documentation for Platypush.
+
+Dependencies required to generate the documentation:
+
+```shell
+$ [sudo] pip install sphinx 'git+https://github.com/bashtage/sphinx-material.git'
+```
+
+To generate the HTML documentation:
+
+```shell
+$ make html
+```
+
+The output will be generated under `build/html`.
+
+Type `make` with no additional arguments to get a full list of the supported output formats.
+

docs/source/_ext/add_dependencies.py

@@ -0,0 +1,186 @@
+import inspect
+import os
+import re
+import sys
+import textwrap as tw
+
+from sphinx.application import Sphinx
+
+base_path = os.path.abspath(
+    os.path.join(os.path.dirname(os.path.relpath(__file__)), '..', '..', '..')
+)
+
+sys.path.insert(0, base_path)
+
+from platypush.common.reflection import Integration  # noqa: E402
+from platypush.utils import get_plugin_name_by_class  # noqa: E402
+from platypush.utils.mock import auto_mocks  # noqa: E402
+
+
+class IntegrationEnricher:
+    @staticmethod
+    def add_events(source: list[str], manifest: Integration, idx: int) -> int:
+        if not manifest.events:
+            return idx
+
+        source.insert(
+            idx,
+            'Triggered events\n----------------\n\n'
+            + '\n'.join(
+                f'\t- :class:`{event.__module__}.{event.__qualname__}`'
+                for event in manifest.events
+            )
+            + '\n\n',
+        )
+
+        return idx + 1
+
+    @staticmethod
+    def add_actions(source: list[str], manifest: Integration, idx: int) -> int:
+        if not (manifest.actions and manifest.cls):
+            return idx
+
+        source.insert(
+            idx,
+            'Actions\n-------\n\n'
+            + '\n'.join(
+                f'\t- `{get_plugin_name_by_class(manifest.cls)}.{action} '
+                + f'<#{manifest.cls.__module__}.{manifest.cls.__qualname__}.{action}>`_'
+                for action in sorted(manifest.actions.keys())
+            )
+            + '\n\n',
+        )
+
+        return idx + 1
+
+    @staticmethod
+    def _shellify(title: str, cmd: str) -> str:
+        return (
+            f'**{title}**\n\n'
+            + '.. code-block:: bash\n\n'
+            + tw.indent(cmd, '\t')
+            + '\n\n'
+        )
+
+    @classmethod
+    def add_install_deps(
+        cls, source: list[str], manifest: Integration, idx: int
+    ) -> int:
+        deps = manifest.deps
+        parsed_deps = {
+            'before': deps.before,
+            'pip': deps.pip,
+            'after': deps.after,
+        }
+
+        if not (any(parsed_deps.values()) or deps.by_pkg_manager):
+            return idx
+
+        source.insert(idx, 'Dependencies\n------------\n\n')
+        idx += 1
+
+        if parsed_deps['before']:
+            source.insert(idx, cls._shellify('Pre-install', '\n'.join(deps.before)))
+            idx += 1
+
+        if parsed_deps['pip']:
+            source.insert(
+                idx, cls._shellify('pip', 'pip install ' + ' '.join(deps.pip))
+            )
+            idx += 1
+
+        for pkg_manager, sys_deps in deps.by_pkg_manager.items():
+            if not sys_deps:
+                continue
+
+            source.insert(
+                idx,
+                cls._shellify(
+                    pkg_manager.value.default_os.value.description,
+                    pkg_manager.value.install_doc + ' ' + ' '.join(sys_deps),
+                ),
+            )
+
+            idx += 1
+
+        if parsed_deps['after']:
+            source.insert(idx, cls._shellify('Post-install', '\n'.join(deps.after)))
+            idx += 1
+
+        return idx
+
+    @classmethod
+    def add_description(cls, source: list[str], manifest: Integration, idx: int) -> int:
+        docs = (
+            doc
+            for doc in (
+                inspect.getdoc(manifest.cls) or '',
+                manifest.constructor.doc if manifest.constructor else '',
+            )
+            if doc
+        )
+
+        if not docs:
+            return idx
+
+        docstring = '\n\n'.join(docs)
+        source.insert(idx, f"Description\n-----------\n\n{docstring}\n\n")
+        return idx + 1
+
+    @classmethod
+    def add_conf_snippet(
+        cls, source: list[str], manifest: Integration, idx: int
+    ) -> int:
+        source.insert(
+            idx,
+            tw.dedent(
+                f"""
+                Configuration
+                -------------
+
+                .. code-block:: yaml
+
+{tw.indent(manifest.config_snippet, '                  ')}
+                """
+            ),
+        )
+
+        return idx + 1
+
+    def __call__(self, _: Sphinx, doc: str, source: list[str]):
+        if not (source and re.match(r'^platypush/(backend|plugins)/.*', doc)):
+            return
+
+        src = [src.split('\n') for src in source][0]
+        if len(src) < 3:
+            return
+
+        manifest_file = os.path.join(
+            base_path,
+            *doc.split(os.sep)[:-1],
+            *doc.split(os.sep)[-1].split('.'),
+            'manifest.json',
+        )
+
+        if not os.path.isfile(manifest_file):
+            return
+
+        with auto_mocks():
+            manifest = Integration.from_manifest(manifest_file)
+            idx = self.add_description(src, manifest, idx=3)
+            idx = self.add_conf_snippet(src, manifest, idx=idx)
+            idx = self.add_install_deps(src, manifest, idx=idx)
+            idx = self.add_events(src, manifest, idx=idx)
+            idx = self.add_actions(src, manifest, idx=idx)
+
+        src.insert(idx, '\n\nModule reference\n----------------\n\n')
+        source[0] = '\n'.join(src)
+
+
+def setup(app: Sphinx):
+    app.connect('source-read', IntegrationEnricher())
+    return {
+        'version': '0.1',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

docs/source/_ext/sphinx_marshmallow.py

@@ -0,0 +1,87 @@
+import importlib
+import json
+import os
+import re
+import sys
+from random import randint
+from typing import Union, List
+
+from docutils import nodes
+from docutils.parsers.rst import Directive
+from marshmallow import fields
+
+
+class SchemaDirective(Directive):
+    """
+    Support for response/message schemas in the docs. Format: ``.. schema:: rel_path.SchemaClass(arg1=value1, ...)``,
+    where ``rel_path`` is the path of the schema relative to ``platypush/schemas``.
+    """
+    has_content = True
+    _schema_regex = re.compile(r'^\s*(.+?)\s*(\((.+?)\))?\s*$')
+    _schemas_path = os.path.abspath(
+        os.path.join(
+            os.path.dirname(os.path.relpath(__file__)), '..', '..', '..', 'platypush', 'schemas'))
+
+    sys.path.insert(0, _schemas_path)
+
+    @classmethod
+    def _get_field_value(cls, field):
+        metadata = getattr(field, 'metadata', {})
+        if metadata.get('example'):
+            return metadata['example']
+        if metadata.get('description'):
+            return metadata['description']
+
+        if isinstance(field, fields.Number):
+            return randint(1, 99)
+        if isinstance(field, fields.Boolean):
+            return bool(randint(0, 1))
+        if isinstance(field, fields.URL):
+            return 'https://example.org'
+        if isinstance(field, fields.List):
+            return [cls._get_field_value(field.inner)]
+        if isinstance(field, fields.Dict):
+            return {
+                cls._get_field_value(field.key_field) if field.key_field else 'key':
+                    cls._get_field_value(field.value_field) if field.value_field else 'value'
+            }
+        if isinstance(field, fields.Nested):
+            ret = {
+                name: cls._get_field_value(f)
+                for name, f in field.nested().fields.items()
+            }
+
+            return [ret] if field.many else ret
+
+        return str(field.__class__.__name__).lower()
+
+    def _parse_schema(self) -> Union[dict, List[dict]]:
+        m = self._schema_regex.match('\n'.join(self.content))
+        schema_module_name = '.'.join(['platypush.schemas', *(m.group(1).split('.')[:-1])])
+        schema_module = importlib.import_module(schema_module_name)
+        schema_class = getattr(schema_module, m.group(1).split('.')[-1])
+        schema_args = eval(f'dict({m.group(3)})') if m.group(3) else {}
+        schema = schema_class(**schema_args)
+        output = {
+            name: self._get_field_value(field)
+            for name, field in schema.fields.items()
+            if not field.load_only
+        }
+
+        return [output] if schema.many else output
+
+    def run(self):
+        content = json.dumps(self._parse_schema(), sort_keys=True, indent=2)
+        block = nodes.literal_block(content, content)
+        block['language'] = 'json'
+        return [block]
+
+
+def setup(app):
+    app.add_directive('schema', SchemaDirective)
+
+    return {
+        'version': '0.1',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

docs/source/_static/scripts/custom.js

@@ -0,0 +1,249 @@
+const processList = (list, level, addTitle) => {
+  const title = list.parentElement.querySelector('a')
+  list.classList.add('grid')
+  if (addTitle)
+    title.classList.add('grid-title')
+
+  list.querySelectorAll(`li.toctree-l${level}`).forEach((item) => {
+    const link = item.querySelector('a')
+    if (link) {
+      item.style.cursor = 'pointer'
+      item.addEventListener('click', () => link.click())
+    }
+
+    const name = item.querySelector('a').innerText
+    const img = document.createElement('img')
+    img.src = `https://static.platypush.tech/icons/${name.toLowerCase()}-64.png`
+    img.alt = ' '
+    item.prepend(img)
+  })
+}
+
+const addClipboard = (parent) => {
+  const pre = parent.tagName === 'PRE' ? parent : parent.querySelector('pre')
+  if (!pre)
+    return
+
+  const clipboard = document.createElement('i')
+  const setClipboard = (img, text) => {
+    clipboard.innerHTML = `<img src="https://static.platypush.tech/icons/${img}-64.png" alt="${text}">`
+  }
+
+  clipboard.classList.add('clipboard')
+  setClipboard('clipboard-bw', 'Copy')
+  clipboard.onclick = () => {
+    if (navigator && navigator.clipboard && navigator.clipboard.writeText) {
+      setClipboard('ok', 'Copied!')
+      setTimeout(() => setClipboard('clipboard-bw', 'Copy'), 2000)
+      return navigator.clipboard.writeText(pre.innerText.trim())
+    }
+
+    return Promise.reject('The Clipboard API is not available.');
+  }
+
+  pre.style.position = 'relative'
+  pre.appendChild(clipboard)
+}
+
+const Tabs = () => {
+  let selectedTab = null
+  let parent = null
+  let data = {}
+
+  const init = (obj) => {
+    data = obj
+    if (Object.keys(data).length && selectedTab == null)
+      selectedTab = Object.keys(data)[0]
+  }
+
+  const select = (name) => {
+    if (!parent) {
+      console.warn('Cannot select tab: parent not set')
+      return
+    }
+
+    if (!data[name]) {
+      console.warn(`Cannot select tab: invalid name: ${name}`)
+      return
+    }
+
+    const tabsBody = parent.querySelector('.body')
+    selectedTab = name
+    tabsBody.innerHTML = data[selectedTab]
+    parent.querySelectorAll('.tabs li').forEach(
+      (tab) => tab.classList.remove('selected')
+    )
+
+    const tab = [...parent.querySelectorAll('.tabs li')].find(
+      (t) => t.innerText === name
+    )
+
+    if (!tab) {
+      console.warn(`Cannot select tab: invalid name: ${name}`)
+      return
+    }
+
+    addClipboard(tabsBody)
+    tab.classList.add('selected')
+  }
+
+  const mount = (p) => {
+    const tabs = document.createElement('div')
+    tabs.classList.add('tabs')
+    parent = p
+
+    const tabsList = document.createElement('ul')
+    Object.keys(data).forEach((title) => {
+      const tab = document.createElement('li')
+      tab.innerText = title
+      tab.onclick = (event) => {
+        event.stopPropagation()
+        select(title)
+      },
+
+      tabsList.appendChild(tab)
+    })
+
+    const tabsBody = document.createElement('div')
+    tabsBody.classList.add('body')
+
+    tabs.appendChild(tabsList)
+    tabs.appendChild(tabsBody)
+    parent.innerHTML = ''
+    parent.appendChild(tabs)
+    select(selectedTab)
+  }
+
+  return {
+    init,
+    select,
+    mount,
+  }
+}
+
+const depsTabs = Tabs()
+
+const convertDepsToTabs = () => {
+  const depsContainer = document.getElementById('dependencies')
+  if (!depsContainer)
+    return
+
+  const blocks = [...depsContainer.querySelectorAll('.highlight-bash')].map((block) => block.outerHTML)
+  const titles = [...depsContainer.querySelectorAll('p strong')].map((title) => title.innerText)
+
+  if (!(blocks.length && titles.length && blocks.length === titles.length))
+    return
+
+  const title = depsContainer.querySelector('h2')
+  const tabsData = titles.reduce((obj, title, i) => {
+    obj[title] = blocks[i]
+    return obj
+  }, {})
+
+  depsTabs.init(tabsData)
+  depsTabs.mount(depsContainer)
+  depsContainer.prepend(title)
+}
+
+const generateComponentsGrid = () => {
+  const tocWrappers = document.querySelectorAll('.toctree-wrapper.compound')
+
+  if (!tocWrappers.length) {
+    return
+  }
+
+  if (window.location.pathname.endsWith('/index.html')) {
+    if (tocWrappers.length < 2) {
+      return
+    }
+
+    const referenceLists = [
+      ...tocWrappers[1].querySelectorAll('ul li.toctree-l1 ul')
+    ].slice(0, 4)
+
+    referenceLists.forEach((list) => processList(list, 2, true))
+  } else if (window.location.pathname.endsWith('/plugins.html') || window.location.pathname.endsWith('/backends.html')) {
+    if (tocWrappers.length < 1) {
+      return
+    }
+
+    const list = tocWrappers[0].querySelector('ul')
+    if (list)
+      processList(list, 1, false)
+  }
+}
+
+const addClipboardToCodeBlocks = () => {
+  document.querySelectorAll('pre').forEach((pre) => addClipboard(pre))
+}
+
+const renderActionsList = () => {
+  const actionsList = document.getElementById('actions')?.querySelector('ul')
+  if (!actionsList)
+    return
+
+  [...actionsList.querySelectorAll('li')].forEach((li) => {
+    const link = li.querySelector('a')
+    link.innerHTML = `<code class="docutils literal notranslate"><span class="pre">${link.innerText}</span></code>`
+  })
+}
+
+const createFilterBar = () => {
+  const input = document.createElement('input')
+  const referenceSection = document.getElementById('reference')
+
+  input.type = 'text'
+  input.placeholder = 'Filter'
+  input.classList.add('filter-bar')
+  input.addEventListener('input', (event) => {
+    const filter = event.target.value.toLowerCase()
+    referenceSection.querySelectorAll('ul.grid li').forEach((li) => {
+      if (li.innerText.toLowerCase().includes(filter)) {
+        li.style.display = 'flex'
+      } else {
+        li.style.display = 'none'
+      }
+    })
+  })
+
+  return input
+}
+
+const addFilterBar = () => {
+  const container = document.querySelector('.bd-main')
+  if (!container)
+    return
+
+  const referenceSection = document.getElementById('reference')
+  if (!referenceSection)
+    return
+
+  const header = referenceSection.querySelector('h2')
+  if (!header)
+    return
+
+  const origInnerHTML = header.innerHTML
+  header.innerHTML = '<span class="header-content">' + origInnerHTML + '</span>'
+
+  const input = createFilterBar()
+  header.appendChild(input)
+
+  const headerOffsetTop = header.offsetTop
+
+  // Apply the fixed class if the header is above the viewport
+  document.addEventListener('scroll', () => {
+    if (headerOffsetTop < window.scrollY) {
+      header.classList.add('fixed')
+    } else {
+      header.classList.remove('fixed')
+    }
+  })
+}
+
+document.addEventListener("DOMContentLoaded", function() {
+  generateComponentsGrid()
+  convertDepsToTabs()
+  addClipboardToCodeBlocks()
+  renderActionsList()
+  addFilterBar()
+})

docs/source/_static/styles/custom.css

@@ -0,0 +1,187 @@
+a, a:visited {
+  /* Don't change the color for visited links */
+  color: var(--pst-color-link) !important;
+}
+
+ul.grid {
+  display: grid;
+
+  @media screen and (max-width: 500px) {
+    grid-template-columns: repeat(1, 1fr);
+  }
+
+  @media screen and (min-width: 501px) and (max-width: 699px) {
+    grid-template-columns: repeat(2, 1fr);
+  }
+
+  @media screen and (min-width: 700px) {
+    grid-template-columns: repeat(3, 1fr);
+  }
+}
+
+a.grid-title {
+  width: 100%;
+  display: block;
+  margin: 1.5em 0;
+  font-size: 1.5em !important;
+  border-bottom: 1px solid #ccc;
+}
+
+ul.grid li {
+  display: flex;
+  background: linear-gradient(0deg, #fff, #f9f9f9);
+  align-items: center;
+  justify-content: space-between;
+  margin: 0 10px 10px 0;
+  padding: 20px;
+  border: 1px solid #ccc;
+  border-radius: 15px;
+  flex-direction: column;
+}
+
+ul.grid img {
+  width: 48px;
+  margin-right: 5px;
+}
+
+ul.grid li code {
+  width: 100%;
+}
+
+ul.grid li code .pre {
+  width: 100%;
+  display: block;
+  white-space: pre-wrap;
+}
+
+ul.grid li:hover {
+  background: linear-gradient(0deg, #157765, #cbffd8) !important;
+}
+
+ul.grid li a {
+  width: 100%;
+  display: flex;
+  justify-content: center;
+  text-align: center;
+  margin-top: 0.5em;
+}
+
+ul.grid li:hover a {
+  color: white !important;
+}
+
+ul.grid li a code {
+  background: none;
+  border: none;
+}
+
+ul.grid .icon {
+  width: 32px;
+}
+
+/* Clipboard button */
+.clipboard {
+  position: absolute;
+  display: inline-block;
+  width: 32px;
+  top: 0.5em;
+  right: 0.5em;
+  cursor: pointer;
+}
+
+/* Tabs */
+.tabs {
+  margin: 0 0 1em 0;
+  padding: 0;
+  list-style: none;
+}
+
+.tabs ul {
+  display: flex;
+  flex-direction: row;
+  justify-content: space-between;
+  align-items: center;
+  margin: 0 0 1em 0;
+  padding: 0;
+  list-style: none;
+  border-bottom: 1px solid #ccc;
+}
+
+.tabs ul li {
+  display: inline-flex;
+  max-width: 25%;
+  margin: 0;
+  padding: 0.25em 0.5em;
+  list-style: none;
+  cursor: pointer;
+  flex-grow: 1;
+  justify-content: center;
+  align-items: center;
+  border-radius: 0.75em 0.75em 0 0;
+  border: 1px solid #ddd;
+}
+
+.tabs ul li.selected {
+  background: rgb(200,255,208);
+}
+
+.tabs ul li:hover {
+  background: rgb(190,246,218);
+}
+
+.tabs .body {
+  margin-top: -1em;
+  padding: 1em;
+  border: 1px solid #ccc;
+  border-top: none;
+  border-radius: 0 0 0.75em 0.75em;
+}
+
+.bd-article-container {
+  position: relative;
+}
+
+.filter-bar {
+  width: 100%;
+  display: block;
+  font-size: 0.6em;
+  border: 1px solid #ccc;
+  border-radius: 0.75em;
+  margin: 0.5em 0;
+  padding: 0.25em;
+}
+
+#reference h2.fixed {
+  position: fixed;
+  top: 0;
+  background: white;
+  z-index: 1;
+}
+
+#reference h2.fixed .header-content {
+  display: none;
+}
+
+@media screen and (max-width: 768px) {
+  #reference h2.fixed {
+    width: 100%;
+    margin-left: -0.5em;
+    padding: 0.5em 0.5em 0 0.5em;
+  }
+}
+
+@media screen and (max-width: 959px) {
+  #reference h2.fixed {
+    width: 100%;
+    margin-left: -1em;
+    padding: 0.5em 0.5em 0 0.5em;
+  }
+}
+
+@media screen and (min-width: 960px) {
+  #reference h2.fixed {
+    width: 75%;
+    max-width: 800px;
+    padding-top: 0.5em;
+  }
+}

docs/source/backends.rst

@@ -3,70 +3,10 @@ Backends
 ========
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :caption: Backends:
 
-    platypush/backend/adafruit.io.rst
-    platypush/backend/alarm.rst
-    platypush/backend/assistant.rst
-    platypush/backend/assistant.google.rst
-    platypush/backend/assistant.snowboy.rst
-    platypush/backend/bluetooth.rst
-    platypush/backend/bluetooth.fileserver.rst
-    platypush/backend/bluetooth.pushserver.rst
-    platypush/backend/bluetooth.scanner.rst
-    platypush/backend/bluetooth.scanner.ble.rst
-    platypush/backend/button.flic.rst
-    platypush/backend/camera.pi.rst
-    platypush/backend/chat.telegram.rst
-    platypush/backend/foursquare.rst
-    platypush/backend/google.fit.rst
-    platypush/backend/google.pubsub.rst
-    platypush/backend/gps.rst
     platypush/backend/http.rst
-    platypush/backend/http.poll.rst
-    platypush/backend/inotify.rst
-    platypush/backend/joystick.rst
-    platypush/backend/kafka.rst
-    platypush/backend/light.hue.rst
-    platypush/backend/linode.rst
-    platypush/backend/local.rst
-    platypush/backend/midi.rst
-    platypush/backend/mqtt.rst
-    platypush/backend/music.mopidy.rst
-    platypush/backend/music.mpd.rst
-    platypush/backend/music.snapcast.rst
-    platypush/backend/nfc.rst
     platypush/backend/nodered.rst
-    platypush/backend/ping.rst
-    platypush/backend/pushbullet.rst
     platypush/backend/redis.rst
-    platypush/backend/scard.rst
-    platypush/backend/sensor.rst
-    platypush/backend/sensor.accelerometer.rst
-    platypush/backend/sensor.arduino.rst
-    platypush/backend/sensor.battery.rst
-    platypush/backend/sensor.bme280.rst
-    platypush/backend/sensor.distance.rst
-    platypush/backend/sensor.distance.vl53l1x.rst
-    platypush/backend/sensor.envirophat.rst
-    platypush/backend/sensor.ir.zeroborg.rst
-    platypush/backend/sensor.leap.rst
-    platypush/backend/sensor.ltr559.rst
-    platypush/backend/sensor.mcp3008.rst
-    platypush/backend/sensor.motion.pwm3901.rst
-    platypush/backend/sensor.serial.rst
-    platypush/backend/stt.rst
-    platypush/backend/stt.deepspeech.rst
-    platypush/backend/stt.picovoice.hotword.rst
-    platypush/backend/stt.picovoice.speech.rst
     platypush/backend/tcp.rst
-    platypush/backend/todoist.rst
-    platypush/backend/travisci.rst
-    platypush/backend/trello.rst
-    platypush/backend/weather.buienradar.rst
-    platypush/backend/weather.darksky.rst
-    platypush/backend/websocket.rst
-    platypush/backend/wiimote.rst
-    platypush/backend/zigbee.mqtt.rst
-    platypush/backend/zwave.rst

docs/source/conf.py

@@ -15,16 +15,14 @@ import sys
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("./_ext"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'platypush'
-copyright = '2017-2019, Fabio Manganiello'
-author = 'Fabio Manganiello'
+project = 'Platypush'
+copyright = '2017-2023, Fabio Manganiello'
+author = 'Fabio Manganiello <fabio@manganiello.tech>'
 
 # The short X.Y version
 version = ''
@@ -42,6 +40,7 @@ release = ''
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'myst_parser',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
@@ -50,6 +49,8 @@ extensions = [
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinx_rtd_theme',
+    'sphinx_marshmallow',
+    'add_dependencies',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -58,8 +59,8 @@ templates_path = ['_templates']
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'
@@ -69,7 +70,7 @@ master_doc = 'index'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -86,20 +87,39 @@ pygments_style = 'sphinx'
 # a list of builtin themes.
 #
 # html_theme = 'haiku'
-html_theme = 'sphinx_rtd_theme'
+# html_theme = 'sphinx_rtd_theme'
+html_theme = 'sphinx_book_theme'
 
+html_title = 'Platypush Documentation'
+html_logo = '../../assets/logo-64.png'
+html_favicon = '../../platypush/backend/http/webapp/public/favicon.ico'
 html_domain_indices = True
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'toc_title': 'Platypush documentation',
+    'repository_url': 'https://git.platypush.tech/platypush/platypush',
+    'repository_provider': 'github',
+    'use_repository_button': True,
+    'use_issues_button': True,
+    'use_fullscreen_button': True,
+    'home_page_in_toc': True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
+html_css_files = [
+    'styles/custom.css',
+]
+
+html_js_files = [
+    'scripts/custom.js',
+]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -109,8 +129,9 @@ html_domain_indices = True
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
 #
-# html_sidebars = {}
-
+# html_sidebars = {
+#     '**': ['logo-text.html', 'globaltoc.html', 'localtoc.html', 'searchbox.html']
+# }
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -124,15 +145,12 @@ latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -142,8 +160,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'platypush.tex', 'platypush Documentation',
-     'BlackLight', 'manual'),
+    (master_doc, 'platypush.tex', 'platypush Documentation', 'BlackLight', 'manual'),
 ]
 
 
@@ -151,21 +168,24 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'platypush', 'platypush Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, 'platypush', 'platypush Documentation', [author], 1)]
 
 
-# -- Options for Texinfo output ----------------------------------------------
+# -- Options for TexInfo output ----------------------------------------------
 
-# Grouping the document tree into Texinfo files. List of tuples
+# Grouping the document tree into TexInfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'platypush', 'platypush Documentation',
-     author, 'platypush', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        'platypush',
+        'platypush Documentation',
+        author,
+        'platypush',
+        'A general-purpose platform for automation.',
+        'Miscellaneous',
+    ),
 ]
 
 
@@ -174,91 +194,32 @@ texinfo_documents = [
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
 
-# -- Options for todo extension ----------------------------------------------
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
-
-autodoc_mock_imports = ['googlesamples.assistant.grpc.audio_helpers',
-                        'google.assistant.embedded',
-                        'google.assistant.library',
-                        'google.assistant.library.event',
-                        'google.assistant.library.file_helpers',
-                        'google.oauth2.credentials',
-                        'oauth2client',
-                        'apiclient',
-                        'tenacity',
-                        'smartcard',
-                        'Leap',
-                        'oauth2client',
-                        'rtmidi',
-                        'bluetooth',
-                        'gevent.wsgi',
-                        'Adafruit_IO',
-                        'pyperclip',
-                        'dbus',
-                        'inputs',
-                        'inotify',
-                        'omxplayer',
-                        'plexapi',
-                        'cwiid',
-                        'sounddevice',
-                        'soundfile',
-                        'numpy',
-                        'cv2',
-                        'nfc',
-                        'ndef',
-                        'bcrypt',
-                        'google',
-                        'feedparser',
-                        'kafka',
-                        'googlesamples',
-                        'icalendar',
-                        'httplib2',
-                        'mpd',
-                        'serial',
-                        'pyHS100',
-                        'grpc',
-                        'envirophat',
-                        'gps',
-                        'picamera',
-                        'pwm3901',
-                        'PIL',
-                        'croniter',
-                        'pyaudio',
-                        'avs',
-                        'PyOBEX',
-                        'todoist',
-                        'trello',
-                        'telegram',
-                        'telegram.ext',
-                        'pyfirmata2',
-                        'cups',
-                        'graphyte',
-                        'cpuinfo',
-                        'psutil',
-                        'openzwave',
-                        'deepspeech',
-                        'wave',
-                        'pvporcupine ',
-                        'pvcheetah',
-                        'pyotp',
-                        'linode_api4',
-                        'pyzbar',
-                        'tensorflow',
-                        'keras',
-                        'pandas',
-                        ]
+autodoc_default_options = {
+    'members': True,
+    'show-inheritance': True,
+}
 
 sys.path.insert(0, os.path.abspath('../..'))
 
-def skip(app, what, name, obj, skip, options):
+from platypush.utils.mock.modules import mock_imports  # noqa
+
+autodoc_mock_imports = [*mock_imports]
+
+
+# _ = app
+# __ = what
+# ___ = obj
+# ____ = options
+def _skip(_, __, name, ___, skip, ____):
     if name == "__init__":
         return False
     return skip
 
-def setup(app):
-    app.connect("autodoc-skip-member", skip)
 
+def setup(app):
+    app.connect("autodoc-skip-member", _skip)
+
+
+# vim:sw=4:ts=4:et:

docs/source/events.rst

@@ -3,43 +3,58 @@ Events
 ======
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :caption: Events:
 
-    platypush/events/.rst
     platypush/events/adafruit.rst
     platypush/events/alarm.rst
     platypush/events/application.rst
     platypush/events/assistant.rst
     platypush/events/bluetooth.rst
-    platypush/events/button.flic.rst
     platypush/events/camera.rst
-    platypush/events/chat.telegram.rst
+    platypush/events/chat.slack.rst
+    platypush/events/clipboard.rst
+    platypush/events/custom.rst
+    platypush/events/dbus.rst
     platypush/events/distance.rst
+    platypush/events/entities.rst
+    platypush/events/file.rst
+    platypush/events/flic.rst
     platypush/events/foursquare.rst
     platypush/events/geo.rst
+    platypush/events/github.rst
     platypush/events/google.rst
-    platypush/events/google.fit.rst
     platypush/events/google.pubsub.rst
+    platypush/events/gotify.rst
+    platypush/events/gpio.rst
     platypush/events/gps.rst
+    platypush/events/hid.rst
     platypush/events/http.rst
     platypush/events/http.hook.rst
-    platypush/events/http.ota.booking.rst
     platypush/events/http.rss.rst
+    platypush/events/inotify.rst
+    platypush/events/irc.rst
     platypush/events/joystick.rst
     platypush/events/kafka.rst
     platypush/events/light.rst
     platypush/events/linode.rst
+    platypush/events/log.http.rst
+    platypush/events/mail.rst
+    platypush/events/matrix.rst
     platypush/events/media.rst
     platypush/events/midi.rst
     platypush/events/mqtt.rst
     platypush/events/music.rst
     platypush/events/music.snapcast.rst
+    platypush/events/music.tidal.rst
+    platypush/events/nextcloud.rst
     platypush/events/nfc.rst
-    platypush/events/path.rst
+    platypush/events/ngrok.rst
+    platypush/events/ntfy.rst
     platypush/events/ping.rst
     platypush/events/pushbullet.rst
     platypush/events/qrcode.rst
+    platypush/events/rss.rst
     platypush/events/scard.rst
     platypush/events/sensor.rst
     platypush/events/sensor.ir.rst
@@ -48,16 +63,18 @@ Events
     platypush/events/serial.rst
     platypush/events/sound.rst
     platypush/events/stt.rst
+    platypush/events/sun.rst
+    platypush/events/telegram.rst
     platypush/events/tensorflow.rst
-    platypush/events/todoist.rst
     platypush/events/torrent.rst
-    platypush/events/travisci.rst
     platypush/events/trello.rst
     platypush/events/video.rst
     platypush/events/weather.rst
     platypush/events/web.rst
     platypush/events/web.widget.rst
-    platypush/events/wiimote.rst
+    platypush/events/websocket.rst
+    platypush/events/xmpp.rst
     platypush/events/zeroborg.rst
+    platypush/events/zeroconf.rst
     platypush/events/zigbee.mqtt.rst
     platypush/events/zwave.rst

docs/source/index.rst

@@ -1,26 +1,55 @@
 Platypush
 #########
 
-Welcome to the Platypush reference of available plugins, backends and event types.
+Description
+===========
 
-For more information on Platypush please check out:
+This is the main documentation hub for Platypush. It includes both the wiki and
+the complete reference of the available integrations.
 
-* The `GitHub page`_ of the project
-* The `online wiki`_ for quickstart and examples
-* The `Medium stories`_ for inspiration about possible projects
+Platypush is a general-purpose automation framework that can be used to cover
+all the cases where you'd use a home automation hub, a media center, a smart
+assistant, some IFTTT recipes, and a variety of other products and services.
 
-.. _GitHub page: https://github.com/BlackLight/platypush
-.. _online wiki: https://github.com/BlackLight/platypush/wiki
-.. _Medium stories: https://medium.com/tag/platypush/archive
+It draws inspiration from the following projects, and it aims to cover all of
+their use-cases:
+
+* `Home Assistant <https://www.home-assistant.io/>`_
+* `Homebridge <https://homebridge.io/>`_
+* `OpenHAB <https://www.openhab.org/>`_
+* `IFTTT <https://ifttt.com/>`_
+* `Tasker <https://tasker.joaoapps.com/>`_
+
+Useful links
+============
+
+* The `main page <https://platypush.tech>`_ of the project.
+* The `Gitea page <https://git.platypush.tech/platypush/platypush>`_.
+* The `blog <https://blog.platypush.tech>`_, for articles showing how to use
+  Platypush in real-world scenarios.
+
+Wiki
+====
 
 .. toctree::
     :maxdepth: 3
-    :caption: Contents:
+
+    wiki/index
+    wiki/Installation
+    wiki/Configuration
+    wiki/Installing-extensions
+    wiki/A-configuration-example
+    wiki/The-Web-interface
+
+Reference
+=========
+
+.. toctree::
+    :maxdepth: 2
 
     backends
     plugins
     events
-    responses
 
 Indices and tables
 ==================
@@ -28,4 +57,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/source/platypush/backend/adafruit.io.rst

@@ -1,6 +0,0 @@
-``platypush.backend.adafruit.io``
-=================================
-
-.. automodule:: platypush.backend.adafruit.io
-	:members:
-

docs/source/platypush/backend/alarm.rst

@@ -1,5 +0,0 @@
-``platypush.backend.alarm``
-===========================
-
-.. automodule:: platypush.backend.alarm
-    :members:

docs/source/platypush/backend/assistant.google.rst

@@ -1,6 +0,0 @@
-``platypush.backend.assistant.google``
-======================================
-
-.. automodule:: platypush.backend.assistant.google
-    :members:
-

docs/source/platypush/backend/assistant.rst

@@ -1,5 +0,0 @@
-``platypush.backend.assistant``
-===============================
-
-.. automodule:: platypush.backend.assistant
-    :members:

docs/source/platypush/backend/assistant.snowboy.rst

@@ -1,6 +0,0 @@
-``platypush.backend.assistant.snowboy``
-=======================================
-
-.. automodule:: platypush.backend.assistant.snowboy
-    :members:
-

docs/source/platypush/backend/bluetooth.fileserver.rst

@@ -1,6 +0,0 @@
-``platypush.backend.bluetooth.fileserver``
-==========================================
-
-.. automodule:: platypush.backend.bluetooth.fileserver
-	:members:
-

docs/source/platypush/backend/bluetooth.pushserver.rst

@@ -1,6 +0,0 @@
-``platypush.backend.bluetooth.pushserver``
-==========================================
-
-.. automodule:: platypush.backend.bluetooth.pushserver
-	:members:
-

docs/source/platypush/backend/bluetooth.rst

@@ -1,5 +0,0 @@
-``platypush.backend.bluetooth``
-===============================
-
-.. automodule:: platypush.backend.bluetooth
-    :members:

docs/source/platypush/backend/bluetooth.scanner.ble.rst

@@ -1,5 +0,0 @@
-``platypush.backend.bluetooth.scanner.ble``
-===========================================
-
-.. automodule:: platypush.backend.bluetooth.scanner.ble
-    :members:

docs/source/platypush/backend/bluetooth.scanner.rst

@@ -1,5 +0,0 @@
-``platypush.backend.bluetooth.scanner``
-=======================================
-
-.. automodule:: platypush.backend.bluetooth.scanner
-    :members:

docs/source/platypush/backend/button.flic.rst

@@ -1,6 +0,0 @@
-``platypush.backend.button.flic``
-=================================
-
-.. automodule:: platypush.backend.button.flic
-    :members:
-

docs/source/platypush/backend/camera.pi.rst

@@ -1,6 +0,0 @@
-``platypush.backend.camera.pi``
-===============================
-
-.. automodule:: platypush.backend.camera.pi
-    :members:
-

docs/source/platypush/backend/chat.telegram.rst

@@ -1,5 +0,0 @@
-``platypush.backend.chat.telegram``
-===================================
-
-.. automodule:: platypush.backend.chat.telegram
-    :members:

docs/source/platypush/backend/foursquare.rst

@@ -1,5 +0,0 @@
-``platypush.backend.foursquare``
-================================
-
-.. automodule:: platypush.backend.foursquare
-    :members:

docs/source/platypush/backend/google.fit.rst

@@ -1,6 +0,0 @@
-``platypush.backend.google.fit``
-================================
-
-.. automodule:: platypush.backend.google.fit
-    :members:
-

docs/source/platypush/backend/google.pubsub.rst

@@ -1,5 +0,0 @@
-``platypush.backend.google.pubsub``
-===================================
-
-.. automodule:: platypush.backend.google.pubsub
-    :members:

docs/source/platypush/backend/gps.rst

@@ -1,6 +0,0 @@
-``platypush.backend.gps``
-=========================
-
-.. automodule:: platypush.backend.gps
-    :members:
-

docs/source/platypush/backend/http.poll.rst

@@ -1,6 +0,0 @@
-``platypush.backend.http.poll``
-===============================
-
-.. automodule:: platypush.backend.http.poll
-    :members:
-

docs/source/platypush/backend/http.rst

@@ -1,4 +1,4 @@
-``platypush.backend.http``
+``http``
 ==========================
 
 .. automodule:: platypush.backend.http

docs/source/platypush/backend/inotify.rst

@@ -1,6 +0,0 @@
-``platypush.backend.inotify``
-=============================
-
-.. automodule:: platypush.backend.inotify
-    :members:
-

docs/source/platypush/backend/joystick.rst

@@ -1,6 +0,0 @@
-``platypush.backend.joystick``
-==============================
-
-.. automodule:: platypush.backend.joystick
-    :members:
-

docs/source/platypush/backend/kafka.rst

@@ -1,6 +0,0 @@
-``platypush.backend.kafka``
-===========================
-
-.. automodule:: platypush.backend.kafka
-    :members:
-

docs/source/platypush/backend/light.hue.rst

@@ -1,6 +0,0 @@
-``platypush.backend.light.hue``
-===============================
-
-.. automodule:: platypush.backend.light.hue
-	:members:
-

docs/source/platypush/backend/linode.rst

@@ -1,5 +0,0 @@
-``platypush.backend.linode``
-============================
-
-.. automodule:: platypush.backend.linode
-    :members:

docs/source/platypush/backend/local.rst

@@ -1,5 +0,0 @@
-``platypush.backend.local``
-===========================
-
-.. automodule:: platypush.backend.local
-    :members:

docs/source/platypush/backend/midi.rst

@@ -1,6 +0,0 @@
-``platypush.backend.midi``
-==========================
-
-.. automodule:: platypush.backend.midi
-    :members:
-

docs/source/platypush/backend/mqtt.rst

@@ -1,6 +0,0 @@
-``platypush.backend.mqtt``
-==========================
-
-.. automodule:: platypush.backend.mqtt
-    :members:
-

docs/source/platypush/backend/music.mopidy.rst

@@ -1,6 +0,0 @@
-``platypush.backend.music.mopidy``
-==================================
-
-.. automodule:: platypush.backend.music.mopidy
-	:members:
-

docs/source/platypush/backend/music.mpd.rst

@@ -1,6 +0,0 @@
-``platypush.backend.music.mpd``
-===============================
-
-.. automodule:: platypush.backend.music.mpd
-    :members:
-

docs/source/platypush/backend/music.snapcast.rst

@@ -1,6 +0,0 @@
-``platypush.backend.music.snapcast``
-====================================
-
-.. automodule:: platypush.backend.music.snapcast
-	:members:
-

docs/source/platypush/backend/nfc.rst

@@ -1,6 +0,0 @@
-``platypush.backend.nfc``
-=========================
-
-.. automodule:: platypush.backend.nfc
-    :members:
-

docs/source/platypush/backend/nodered.rst

@@ -1,4 +1,4 @@
-``platypush.backend.nodered``
+``nodered``
 =============================
 
 .. automodule:: platypush.backend.nodered

docs/source/platypush/backend/ping.rst

@@ -1,5 +0,0 @@
-``platypush.backend.ping``
-==========================
-
-.. automodule:: platypush.backend.ping
-    :members:

docs/source/platypush/backend/pushbullet.rst

@@ -1,6 +0,0 @@
-``platypush.backend.pushbullet``
-================================
-
-.. automodule:: platypush.backend.pushbullet
-    :members:
-

docs/source/platypush/backend/redis.rst

@@ -1,4 +1,4 @@
-``platypush.backend.redis``
+``redis``
 ===========================
 
 .. automodule:: platypush.backend.redis

docs/source/platypush/backend/scard.rst

@@ -1,6 +0,0 @@
-``platypush.backend.scard``
-===========================
-
-.. automodule:: platypush.backend.scard
-    :members:
-

docs/source/platypush/backend/sensor.accelerometer.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.accelerometer``
-==========================================
-
-.. automodule:: platypush.backend.sensor.accelerometer
-    :members:
-

docs/source/platypush/backend/sensor.arduino.rst

@@ -1,5 +0,0 @@
-``platypush.backend.sensor.arduino``
-====================================
-
-.. automodule:: platypush.backend.sensor.arduino
-    :members:

docs/source/platypush/backend/sensor.battery.rst

@@ -1,5 +0,0 @@
-``platypush.backend.sensor.battery``
-====================================
-
-.. automodule:: platypush.backend.sensor.battery
-    :members:

docs/source/platypush/backend/sensor.bme280.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.bme280``
-===================================
-
-.. automodule:: platypush.backend.sensor.bme280
-	:members:
-

docs/source/platypush/backend/sensor.distance.rst

@@ -1,5 +0,0 @@
-``platypush.backend.sensor.distance``
-=====================================
-
-.. automodule:: platypush.backend.sensor.distance
-    :members:

docs/source/platypush/backend/sensor.distance.vl53l1x.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.distance.vl53l1x``
-=============================================
-
-.. automodule:: platypush.backend.sensor.distance.vl53l1x
-	:members:
-

docs/source/platypush/backend/sensor.envirophat.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.envirophat``
-=======================================
-
-.. automodule:: platypush.backend.sensor.envirophat
-    :members:
-

docs/source/platypush/backend/sensor.ir.zeroborg.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.ir.zeroborg``
-========================================
-
-.. automodule:: platypush.backend.sensor.ir.zeroborg
-    :members:
-

docs/source/platypush/backend/sensor.leap.rst

@@ -1,7 +0,0 @@
-``platypush.backend.sensor.leap``
-=================================
-
-.. automodule:: platypush.backend.sensor.leap
-    :members:
-
-

docs/source/platypush/backend/sensor.ltr559.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.ltr559``
-===================================
-
-.. automodule:: platypush.backend.sensor.ltr559
-	:members:
-

docs/source/platypush/backend/sensor.mcp3008.rst

@@ -1,8 +0,0 @@
-``platypush.backend.sensor.mcp3008``
-====================================
-
-.. automodule:: platypush.backend.sensor.mcp3008
-    :members:
-
-
-

docs/source/platypush/backend/sensor.motion.pwm3901.rst

@@ -1,5 +0,0 @@
-``platypush.backend.sensor.motion.pwm3901``
-===========================================
-
-.. automodule:: platypush.backend.sensor.motion.pwm3901
-    :members:

docs/source/platypush/backend/sensor.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor``
-============================
-
-.. automodule:: platypush.backend.sensor
-    :members:
-

docs/source/platypush/backend/sensor.serial.rst

@@ -1,6 +0,0 @@
-``platypush.backend.sensor.serial``
-===================================
-
-.. automodule:: platypush.backend.sensor.serial
-    :members:
-

docs/source/platypush/backend/stt.deepspeech.rst

@@ -1,5 +0,0 @@
-``platypush.backend.stt.deepspeech``
-====================================
-
-.. automodule:: platypush.backend.stt.deepspeech
-    :members:

docs/source/platypush/backend/stt.picovoice.hotword.rst

@@ -1,5 +0,0 @@
-``platypush.backend.stt.picovoice.hotword``
-===========================================
-
-.. automodule:: platypush.backend.stt.picovoice.hotword
-    :members:

docs/source/platypush/backend/stt.picovoice.rst

@@ -1,5 +0,0 @@
-``platypush.backend.stt.picovoice``
-===================================
-
-.. automodule:: platypush.backend.stt.picovoice
-    :members:

docs/source/platypush/backend/stt.picovoice.speech.rst

@@ -1,5 +0,0 @@
-``platypush.backend.stt.picovoice.speech``
-==========================================
-
-.. automodule:: platypush.backend.stt.picovoice.speech
-    :members:

docs/source/platypush/backend/stt.rst

@@ -1,5 +0,0 @@
-``platypush.backend.stt``
-=========================
-
-.. automodule:: platypush.backend.stt
-    :members:

docs/source/platypush/backend/tcp.rst

@@ -1,4 +1,4 @@
-``platypush.backend.tcp``
+``tcp``
 =========================
 
 .. automodule:: platypush.backend.tcp

docs/source/platypush/backend/todoist.rst

@@ -1,5 +0,0 @@
-``platypush.backend.todoist``
-=============================
-
-.. automodule:: platypush.backend.todoist
-    :members:

docs/source/platypush/backend/travisci.rst

@@ -1,5 +0,0 @@
-``platypush.backend.travisci``
-==============================
-
-.. automodule:: platypush.backend.travisci
-    :members:

docs/source/platypush/backend/trello.rst

@@ -1,5 +0,0 @@
-``platypush.backend.trello``
-============================
-
-.. automodule:: platypush.backend.trello
-    :members:

docs/source/platypush/backend/weather.buienradar.rst

@@ -1,5 +0,0 @@
-``platypush.backend.weather.buienradar``
-========================================
-
-.. automodule:: platypush.backend.weather.buienradar
-    :members:

docs/source/platypush/backend/weather.darksky.rst

@@ -1,5 +0,0 @@
-``platypush.backend.weather.darksky``
-=====================================
-
-.. automodule:: platypush.backend.weather.darksky
-    :members:

docs/source/platypush/backend/websocket.rst

@@ -1,6 +0,0 @@
-``platypush.backend.websocket``
-===============================
-
-.. automodule:: platypush.backend.websocket
-	:members:
-

docs/source/platypush/backend/wiimote.rst

@@ -1,6 +0,0 @@
-``platypush.backend.wiimote``
-=============================
-
-.. automodule:: platypush.backend.wiimote
-    :members:
-

docs/source/platypush/backend/zigbee.mqtt.rst

@@ -1,5 +0,0 @@
-``platypush.backend.zigbee.mqtt``
-=================================
-
-.. automodule:: platypush.backend.zigbee.mqtt
-    :members:

docs/source/platypush/backend/zwave.rst

@@ -1,5 +0,0 @@
-``platypush.backend.zwave``
-===========================
-
-.. automodule:: platypush.backend.zwave
-    :members:

docs/source/platypush/events/.rst

@@ -1,5 +0,0 @@
-``platypush.message.event``
-===========================
-
-.. automodule:: platypush.message.event
-    :members:

docs/source/platypush/events/adafruit.rst

@@ -1,4 +1,4 @@
-``platypush.message.event.adafruit``
+``adafruit``
 ====================================
 
 .. automodule:: platypush.message.event.adafruit

docs/source/platypush/events/alarm.rst

@@ -1,4 +1,4 @@
-``platypush.message.event.alarm``
+``alarm``
 =================================
 
 .. automodule:: platypush.message.event.alarm

docs/source/platypush/events/application.rst

@@ -1,4 +1,4 @@
-``platypush.message.event.application``
+``application``
 =======================================
 
 .. automodule:: platypush.message.event.application

docs/source/platypush/events/assistant.rst

@@ -1,4 +1,4 @@
-``platypush.message.event.assistant``
+``assistant``
 =====================================
 
 .. automodule:: platypush.message.event.assistant

docs/source/platypush/events/bluetooth.rst

@@ -1,4 +1,4 @@
-``platypush.message.event.bluetooth``
+``bluetooth``
 =====================================
 
 .. automodule:: platypush.message.event.bluetooth

docs/source/platypush/events/button.flic.rst

@@ -1,6 +0,0 @@
-``platypush.message.event.button.flic``
-=======================================
-
-.. automodule:: platypush.message.event.button.flic
-    :members:
-