`platypush.run` should also support procedures in the format `procedure.<name>`.

```
@procedure("foo")
def bar():
    ...
```

Will now be published as `procedure.foo` instead of
`procedure.<module>.bar`.

.dockerignore

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

.drone.yml

@@ -0,0 +1,383 @@
+---
+kind: pipeline
+type: docker
+name: default
+
+volumes:
+  - name: docs
+    host:
+      path: /opt/docs/platypush
+
+  - name: repos
+    host:
+      path: /opt/repos/platypush
+
+steps:
+
+###
+### Mirror the current repository state to Github
+###
+
+- name: github-mirror
+  image: alpine
+  environment:
+    SSH_PUBKEY:
+      from_secret: ssh_pubkey
+    SSH_PRIVKEY:
+      from_secret: ssh_privkey
+
+  commands:
+    - . .drone/github-mirror.sh
+
+###
+### Synchronize the `stable` branch to the new release
+###
+
+- name: sync-stable-branch
+  image: alpine
+  environment:
+    SSH_PUBKEY:
+      from_secret: ssh_pubkey
+    SSH_PRIVKEY:
+      from_secret: ssh_privkey
+    PGP_KEY:
+      from_secret: pgp_key
+    PGP_KEY_ID:
+      from_secret: pgp_key_id
+
+  commands:
+    - . .drone/sync-stable-branch.sh
+
+  when:
+    event:
+      - tag
+
+###
+### Rebuild the docs
+###
+
+- name: docs
+  image: alpine
+  volumes:
+    - name: docs
+      path: /docs
+
+  commands:
+    - . .drone/rebuild-docs.sh
+
+  when:
+    event:
+      - tag
+
+  depends_on:
+    - sync-stable-branch
+
+###
+### Run the tests
+###
+
+- name: tests
+  image: alpine
+  commands:
+    - . .drone/run-tests.sh
+
+###
+### Rebuild the UI files
+###
+
+- name: build-ui
+  image: node:current-alpine3.18
+
+  environment:
+    SSH_PUBKEY:
+      from_secret: ssh_pubkey
+    SSH_PRIVKEY:
+      from_secret: ssh_privkey
+    PGP_KEY:
+      from_secret: pgp_key
+    PGP_KEY_ID:
+      from_secret: pgp_key_id
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - tests
+
+  commands:
+    - . .drone/build-ui.sh
+
+###
+### Regenerate the components.json cache
+###
+
+- name: update-components-cache
+  image: alpine
+
+  environment:
+    SSH_PUBKEY:
+      from_secret: ssh_pubkey
+    SSH_PRIVKEY:
+      from_secret: ssh_privkey
+    PGP_KEY:
+      from_secret: pgp_key
+    PGP_KEY_ID:
+      from_secret: pgp_key_id
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - build-ui
+
+  commands:
+    - . .drone/update-components-cache.sh
+
+###
+### Update the Arch packages
+###
+
+- name: update-arch-packages
+  image: python:3.11-alpine
+  environment:
+    WORKDIR: /tmp/workdir
+    SSH_PUBKEY:
+      from_secret: ssh_pubkey
+    SSH_PRIVKEY:
+      from_secret: ssh_privkey
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - update-components-cache
+
+  commands:
+    - . .drone/update-arch-packages.sh
+
+###
+### Update the Debian (stable) packages
+###
+
+- name: update-debian-stable-packages
+  image: debian:stable
+  volumes:
+    - name: repos
+      path: /repos
+
+  environment:
+    DEB_VERSION: stable
+    WORKDIR: /tmp/workdir
+    APT_ROOT: /repos/apt
+    PKG_NAME: platypush
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - update-components-cache
+
+  commands:
+    - . .drone/update-deb-packages.sh
+
+###
+### Update the Debian (oldstable) packages
+###
+
+- name: update-debian-oldstable-packages
+  image: debian:oldstable
+  volumes:
+    - name: repos
+      path: /repos
+
+  environment:
+    DEB_VERSION: oldstable
+    WORKDIR: /tmp/workdir
+    APT_ROOT: /repos/apt
+    PKG_NAME: platypush
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - update-components-cache
+
+  commands:
+    - . .drone/update-deb-packages.sh
+
+###
+### Updates the APT repository after new packages have been pushed
+###
+
+- name: update-apt-repo
+  image: debian:stable
+  volumes:
+    - name: repos
+      path: /repos
+
+  environment:
+    REPOS_ROOT: /repos
+    APT_ROOT: /repos/apt
+    PGP_PUBKEY:
+      from_secret: apt_pgp_pub_key
+    PGP_PRIVKEY:
+      from_secret: apt_pgp_priv_key
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - update-debian-stable-packages
+    - update-debian-oldstable-packages
+
+  commands:
+    - . .drone/update-apt-repo.sh
+
+###
+### Update the RPM (stable) packages
+###
+
+- name: update-rpm-repo
+  image: fedora
+  volumes:
+    - name: repos
+      path: /repos
+
+  environment:
+    RPM_VERSION: stable
+    REPOS_ROOT: /repos
+    RPM_ROOT: /repos/rpm
+    WORKDIR: /tmp/workdir
+    PKG_NAME: platypush
+    PGP_PUBKEY:
+      from_secret: rpm_pgp_pub_key
+    PGP_PRIVKEY:
+      from_secret: rpm_pgp_priv_key
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - update-components-cache
+
+  commands:
+    - . .drone/update-rpm-repo.sh
+
+###
+### Updates the pip package upon new releases
+###
+
+- name: update-pip-package
+  image: python:3.11-alpine
+  environment:
+    TWINE_USERNAME:
+      from_secret: pypi_user
+    TWINE_PASSWORD:
+      from_secret: pypi_pass
+
+  when:
+    event:
+      - tag
+
+  depends_on:
+    - tests
+    - docs
+
+  commands:
+    - . .drone/update-pip-package.sh
+
+###
+### Checkpoint step that waits for all the package update
+### steps to complete before proceeding to the next steps.
+###
+
+- name: wait-pkg-update
+  image: alpine
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+
+  depends_on:
+    - update-arch-packages
+    - update-rpm-repo
+    - update-apt-repo
+
+  commands:
+    - echo "All packages have been successfully updated"
+
+###
+### Notifies about a new release
+###
+
+- name: notify-release
+  image: python:3.11-alpine
+  environment:
+    WORKER_RPC_SECRET:
+      from_secret: worker_rpc_secret
+
+  when:
+    event:
+      - tag
+
+  depends_on:
+    - update-pip-package
+
+  commands:
+    - apk add --update --no-cache curl
+    - |
+      curl --silent -XPOST \
+        -H "X-Token: $WORKER_RPC_SECRET" \
+        "https://worker.ci-cd.platypush.tech/hook/notify-platypush-release?version=$(python setup.py --version)"
+
+###
+### Notifies about a change in the CI/CD build status
+###
+
+- name: notify-build-status
+  image: alpine
+  environment:
+    WORKER_RPC_SECRET:
+      from_secret: worker_rpc_secret
+
+  when:
+    branch:
+      - master
+    event:
+      - push
+    status:
+      - success
+      - failure
+
+  depends_on:
+    - wait-pkg-update
+
+  commands:
+    - apk add --update --no-cache curl
+    - |
+      curl --silent -XPOST \
+        -H "X-Token: $WORKER_RPC_SECRET" \
+        "https://worker.ci-cd.platypush.tech/hook/notify-platypush-build?status=$DRONE_BUILD_STATUS"

.drone/build-ui.sh

@@ -0,0 +1,43 @@
+#!/bin/sh
+
+export SKIPCI="$PWD/.skipci"
+rm -rf "$SKIPCI"
+
+. .drone/macros/configure-git.sh
+
+cd platypush/backend/http/webapp
+if [ $(git log --pretty=oneline $DRONE_COMMIT_AFTER...$DRONE_COMMIT_BEFORE . | wc -l) -eq 0 ]; then
+  echo "No UI changes detected, skipping build"
+  exit 0
+fi
+
+
+if [ "$(git log --pretty=format:%s HEAD...HEAD~1 | head -1)" == "[Automatic] Updated UI files" ]; then
+  echo "UI changes have already been committed, skipping build"
+  exit 0
+fi
+
+rm -rf dist node_modules
+npm install
+npm run build
+
+if [ $(git status --porcelain dist | wc -l) -eq 0 ]; then
+  echo "No build files have been changed"
+  exit 0
+fi
+
+# Create a .skipci file to mark the fact that the next steps should be skipped
+# (we're going to do another push anyway, so another pipeline will be triggered)
+touch "$SKIPCI"
+
+. .drone/macros/configure-ssh.sh
+. .drone/macros/configure-gpg.sh
+
+git add dist
+git commit dist -S -m "[Automatic] Updated UI files" --no-verify
+git remote rm origin
+git remote add origin git@git.platypush.tech:platypush/platypush.git
+git push -f origin master
+
+# Restore the original git configuration
+mv "$TMP_GIT_CONF" "$GIT_CONF"

.drone/github-mirror.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+. .drone/macros/configure-git.sh
+. .drone/macros/configure-ssh.sh
+
+ssh-keyscan github.com >> ~/.ssh/known_hosts 2>/dev/null
+
+# Clone the repository
+git remote add github git@github.com:/BlackLight/platypush.git
+git pull --rebase github "$(git branch | head -1 | awk '{print $2}')" || echo "No such branch on Github"
+
+# Push the changes to the GitHub mirror
+git push --all -v github

.drone/macros/configure-git.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+
+# Install git
+if [ -z "$(which git)" ]; then
+  if [ -n "$(which apt-get)" ]; then
+    apt-get update
+    apt-get install -y git
+  elif [ -n "$(which apk)" ]; then
+    apk add --update --no-cache git
+  elif [ -n "$(which yum)" ]; then
+    yum install -y git
+  elif [ -n "$(which dnf)" ]; then
+    dnf install -y git
+  elif [ -n "$(which pacman)" ]; then
+    pacman -Sy --noconfirm git
+  else
+    echo "Could not find a package manager to install git"
+    exit 1
+  fi
+fi
+
+# Backup the original git configuration before changing attributes
+export GIT_CONF="$PWD/.git/config"
+export TMP_GIT_CONF=/tmp/git.config.orig
+cp "$GIT_CONF" "$TMP_GIT_CONF"
+
+git config --global --add safe.directory "$PWD"
+git config user.name "Platypush CI/CD Automation"
+git config user.email "admin@platypush.tech"

.drone/macros/configure-gpg.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+[ -z "$PGP_KEY" ] && echo "PGP_KEY is not set" && exit 1
+[ -z "$PGP_KEY_ID" ] && echo "PGP_KEY_ID is not set" && exit 1
+
+# Install gpg
+if [ -z "$(which gpg)" ]; then
+    if [ -n "$(which apt-get)" ]; then
+        apt-get update
+        apt-get install -y gnupg
+    elif [ -n "$(which apk)" ]; then
+        apk add --update --no-cache bash gnupg
+    elif [ -n "$(which yum)" ]; then
+        yum install -y gnupg
+    elif [ -n "$(which dnf)" ]; then
+        dnf install -y gnupg
+    elif [ -n "$(which pacman)" ]; then
+        pacman -Sy --noconfirm gnupg
+    else
+        echo "Could not find a package manager to install gnupg"
+        exit 1
+    fi
+fi
+
+cat <<EOF | gpg --import --armor
+$PGP_KEY
+EOF
+
+git config commit.gpgsign true
+git config user.signingkey "$PGP_KEY_ID"

.drone/macros/configure-ssh.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+if [ -z "$SSH_PUBKEY" ] || [ -z "$SSH_PRIVKEY" ]; then
+    echo "SSH_PUBKEY and SSH_PRIVKEY environment variables must be set"
+    exit 1
+fi
+
+# Install ssh
+if [ -z "$(which ssh)" ]; then
+    if [ -n "$(which apt-get)" ]; then
+        apt-get update
+        apt-get install -y openssh
+    elif [ -n "$(which apk)" ]; then
+        apk add --update --no-cache openssh
+    elif [ -n "$(which yum)" ]; then
+        yum install -y openssh
+    elif [ -n "$(which dnf)" ]; then
+        dnf install -y openssh
+    elif [ -n "$(which pacman)" ]; then
+        pacman -Sy --noconfirm openssh
+    else
+        echo "Could not find a package manager to install openssh"
+        exit 1
+    fi
+fi
+
+mkdir -p ~/.ssh
+echo $SSH_PUBKEY > ~/.ssh/id_rsa.pub
+
+cat <<EOF > ~/.ssh/id_rsa
+$SSH_PRIVKEY
+EOF
+
+chmod 0600 ~/.ssh/id_rsa
+ssh-keyscan git.platypush.tech >> ~/.ssh/known_hosts 2>/dev/null

.drone/rebuild-docs.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+echo "Installing required build dependencies"
+apk add --update --no-cache git make py3-sphinx py3-myst-parser py3-pip $(cat platypush/install/requirements/alpine.txt)
+pip install -U sphinx-rtd-theme sphinx-book-theme --break-system-packages
+pip install . --break-system-packages
+mkdir -p /docs/current
+export APPDIR="$PWD"
+rm -rf "$APPDIR/docs/build"
+
+echo "Building the updated documentation"
+cd "$APPDIR/docs/source"
+git clone 'https://git.platypush.tech/platypush/platypush.wiki.git' wiki
+
+echo "Linking the wiki to the Sphinx index"
+cd wiki
+ln -s Home.md index.md
+cd "$APPDIR/docs"
+make html
+rm -f config*.yaml
+cd "$APPDIR"
+
+echo "Copying the new documentation files to the target folder"
+mv -v "$APPDIR/docs/build" /docs/new
+cd /docs
+mv current old
+mv new current
+rm -rf old

.drone/run-tests.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+apk add --update --no-cache $(cat platypush/install/requirements/alpine.txt)
+pip install . --break-system-packages
+pip install -r requirements-tests.txt --break-system-packages
+pytest tests

.drone/sync-stable-branch.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+. .drone/macros/configure-git.sh
+. .drone/macros/configure-ssh.sh
+. .drone/macros/configure-gpg.sh
+
+# Git configuration
+git remote rm origin
+git remote add origin git@git.platypush.tech:platypush/platypush.git
+
+# Merge and push to the `stable` branch
+git checkout stable
+git rebase master
+git push -u origin stable
+git checkout master
+
+# Restore the original git configuration
+mv "$TMP_GIT_CONF" "$GIT_CONF"

.drone/update-apt-repo.sh

@@ -0,0 +1,166 @@
+#!/bin/sh
+
+
+[ -f .skipci ] && exit 0
+
+echo "-- Installing dependencies"
+apt update
+apt install -y dpkg-dev gpg
+
+echo "-- Creating a new apt root folder"
+export TMP_APT_ROOT="/tmp/apt"
+cp -r "$APT_ROOT" "$TMP_APT_ROOT"
+
+echo "-- Cleaning up older apt releases"
+
+find "$TMP_APT_ROOT/pool" -mindepth 2 -maxdepth 2 -type d | while read reldir; do
+  pkg_to_remove=$(( $(ls "$reldir"/*.deb | wc -l) - 1 ))
+  [ $pkg_to_remove -le 0 ] && continue
+  ls "$reldir"/*.deb | sort -V | head -n$pkg_to_remove | xargs rm -f
+done
+
+echo "-- Updating Packages files"
+
+echo "stable\noldstable" | while read distro; do
+  echo "main\ndev" | while read branch; do
+    branch_dir="$TMP_APT_ROOT/pool/$distro/$branch"
+    echo "Checking pool folder: $branch_dir"
+    [ -d "$branch_dir" ] || mkdir -p "$branch_dir"
+    dist_dir="$TMP_APT_ROOT/dists/$distro/$branch/all"
+    mkdir -p "$dist_dir"
+    pkg_file="$dist_dir/Packages"
+    dpkg-scanpackages --arch all "$branch_dir" > "$pkg_file"
+    sed -i "$pkg_file" -re "s|^Filename: $TMP_APT_ROOT/|Filename: |"
+    cat "$pkg_file" | gzip -9 > "$pkg_file.gz"
+    echo "Generated Packages file: $pkg_file"
+    cat "$pkg_file"
+  done
+done
+
+echo "-- Updating Release files"
+
+add_hashes() {
+  dist_dir=$1
+  hash_cmd=$2
+  hash_label=$3
+
+  echo "$hash_label:"
+  find "$dist_dir" -name 'Packages*' | while read file; do
+    basename="$(echo "$file" | sed -r -e "s|^$dist_dir/||")"
+    hash="$($hash_cmd "$file" | cut -d" " -f1)"
+    size="$(wc -c < $file)"
+    echo " $hash $size $basename"
+    echo " $hash $size $(echo $basename | sed -re 's|/all/|/binary-i386/|')"
+    echo " $hash $size $(echo $basename | sed -re 's|/all/|/binary-amd64/|')"
+    echo " $hash $size $(echo $basename | sed -re 's|/all/|/binary-armel/|')"
+    echo " $hash $size $(echo $basename | sed -re 's|/all/|/binary-armhf/|')"
+    echo " $hash $size $(echo $basename | sed -re 's|/all/|/binary-arm64/|')"
+  done
+}
+
+echo "stable\noldstable" | while read distro; do
+  dist_dir="$TMP_APT_ROOT/dists/$distro"
+  components=$(find "$dist_dir" -name Packages | awk -F '/' '{print $(NF-2)}' | uniq | tr '\n' ' ')
+  release_file="$dist_dir/Release"
+
+  cat <<EOF > "$release_file"
+Origin: Platypush repository
+Label: Platypush
+Suite: $distro
+Codename: $distro
+Architectures: i386 amd64 armel armhf arm64
+Components: $components
+Description: The official APT repository for Platypush
+Date: $(date -Ru)
+EOF
+
+  add_hashes "$dist_dir" "md5sum" "MD5Sum" >> "$release_file"
+  add_hashes "$dist_dir" "sha1sum" "SHA1" >> "$release_file"
+  add_hashes "$dist_dir" "sha256sum" "SHA256" >> "$release_file"
+done
+
+echo "-- Generating list files"
+mkdir -p "$TMP_APT_ROOT/lists"
+
+for distro in stable oldstable; do
+  for branch in main dev; do
+    echo "deb https://apt.platypush.tech/ $distro $branch" > "$TMP_APT_ROOT/lists/platypush-$distro-$branch.list"
+  done
+done
+
+echo "-- Updating index file"
+
+cat <<EOF > "$TMP_APT_ROOT/index.txt"
+Welcome to the Platypush APT repository!
+
+Project homepage: https://platypush.tech
+Source code: https://git.platypush.tech/platypush/platypush
+Documentation / API reference: https://docs.platypush.tech
+
+You can use this APT repository to install Platypush on Debian, Ubuntu or any
+Debian-based distro.
+
+Steps:
+
+1. Add this repository's PGP key to your apt keyring
+====================================================
+
+$ sudo wget -q -O \\\
+    /etc/apt/trusted.gpg.d/platypush.asc \\\
+    https://apt.platypush.tech/pubkey.txt
+
+2. Add the repository to your sources
+=====================================
+
+$ sudo wget -q -O \\\
+    /etc/apt/sources.list.d/platypush.list \\\
+    https://apt.platypush.tech/lists/platypush-<deb_version>-<branch>.list
+
+Where:
+
+- deb_version can be either *stable* (for the current Debian stable version) or
+  *oldstable* (for the previous Debian stable version)
+- branch can be either *main* (for the latest releases) or *dev* (for a package
+  that is always in sync with the git version)
+
+For example, to install the latest stable tags on Debian stable:
+
+$ sudo wget -q -O \\\
+    /etc/apt/sources.list.d/platypush.list \\\
+    https://apt.platypush.tech/lists/platypush-stable-main.list
+
+3. Update your repos
+====================
+
+$ sudo apt update
+
+4. Install Platypush
+====================
+
+$ sudo apt install platypush
+EOF
+
+echo "-- Importing and refreshing PGP key"
+echo "$PGP_PUBKEY" > "$TMP_APT_ROOT/pubkey.txt"
+export PGP_KEYID=$(echo "$PGP_PUBKEY" | gpg --with-colons --import-options show-only --import --fingerprint | grep -e '^fpr:' | head -1 | awk -F ':' '{print $(NF - 1)}')
+
+cat <<EOF | gpg --import --armor
+$PGP_PRIVKEY
+EOF
+
+echo "-- Signing Release files"
+
+find "$TMP_APT_ROOT/dists" -type f -name Release | while read file; do
+  dirname="$(dirname "$file")"
+  cat "$file" | gpg -q --default-key "$PGP_KEYID" -abs > "$file.gpg"
+  cat "$file" | gpg -q --default-key "$PGP_KEYID" -abs --clearsign > "$dirname/InRelease"
+done
+
+echo "-- Updating the apt repo root"
+export OLD_APT_ROOT="$REPOS_ROOT/oldapt"
+rm -rf "$OLD_APT_ROOT"
+mv "$APT_ROOT" "$OLD_APT_ROOT"
+mv "$TMP_APT_ROOT" "$APT_ROOT"
+
+chmod -R a+r "$APT_ROOT"
+chmod a+x "$APT_ROOT"

.drone/update-arch-packages.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+
+[ -f .skipci ] && exit 0
+
+apk add --update --no-cache curl pacman sudo
+
+. .drone/macros/configure-ssh.sh
+. .drone/macros/configure-git.sh
+
+git pull --rebase origin master --tags
+
+export VERSION=$(python setup.py --version)
+export HEAD=$(git log --pretty=format:%h HEAD...HEAD~1 | head -1)
+export GIT_VERSION="$VERSION.r$(git log --pretty=oneline HEAD...v$VERSION | wc -l).g${HEAD}"
+export TAG_URL="https://git.platypush.tech/platypush/platypush/archive/v$VERSION.tar.gz"
+
+ssh-keyscan aur.archlinux.org >> ~/.ssh/known_hosts 2>/dev/null
+adduser -u 1000 -D build
+mkdir -p "$WORKDIR"
+
+echo "--- Updating Arch git version"
+export PKGDIR=$WORKDIR/git
+git clone ssh://aur@aur.archlinux.org/platypush-git.git "$PKGDIR"
+git config --global --add safe.directory "$PKGDIR"
+chown -R build "$PKGDIR"
+cd "$PKGDIR"
+
+sed -i 'PKGBUILD' -r \
+  -e "s/^pkgver=.*/pkgver=$GIT_VERSION/" \
+  -e "s/^pkgrel=.*/pkgrel=1/" \
+
+sudo -u build makepkg --printsrcinfo > .SRCINFO
+export FILES_CHANGED=$(git status --porcelain --untracked-files=no | wc -l)
+
+if [ $FILES_CHANGED -gt 0 ]; then
+  echo "--- Pushing git package version $GIT_VERSION"
+  git commit -a -m '[Automatic] Package update'
+  git push origin master
+fi
+
+echo "--- Updating Arch stable version"
+export PKGDIR="$WORKDIR/stable"
+git clone ssh://aur@aur.archlinux.org/platypush.git "$PKGDIR"
+git config --global --add safe.directory "$PKGDIR"
+chown -R build "$PKGDIR"
+cd "$PKGDIR"
+export RELEASED_VERSION=$(grep -e '^pkgver=' PKGBUILD | sed -r -e 's/^pkgver=(.*)\s*/\1/')
+
+if [ "$RELEASED_VERSION" == "$VERSION" ]; then
+  exit 0
+fi
+
+export TAG_CHECKSUM=$(curl --silent "$TAG_URL" | sha512sum | awk '{print $1}')
+
+sed -i 'PKGBUILD' -r \
+  -e "s/^pkgver=.*/pkgver=$VERSION/" \
+  -e "s/^pkgrel=.*/pkgrel=1/" \
+  -e "s/^sha512sums=.*/sha512sums=('$TAG_CHECKSUM')/"
+
+sudo -u build makepkg --printsrcinfo > .SRCINFO
+export FILES_CHANGED=$(git status --porcelain --untracked-files=no | wc -l)
+
+if [ $FILES_CHANGED -gt 0 ]; then
+  echo "--- Pushing stable package version $VERSION"
+  git commit -a -m '[Automatic] Package update'
+  git push origin master
+fi

.drone/update-components-cache.sh

@@ -0,0 +1,46 @@
+#!/bin/sh
+
+export SKIPCI="$PWD/.skipci"
+export CACHEFILE="$PWD/platypush/components.json.gz"
+
+[ -f "$SKIPCI" ] && exit 0
+
+# Backup the original git configuration before changing attributes
+export GIT_CONF="$PWD/.git/config"
+export TMP_GIT_CONF="/tmp/git.config.orig"
+cp "$GIT_CONF" "$TMP_GIT_CONF"
+
+. .drone/macros/configure-git.sh
+
+# Only regenerate the components cache if either the plugins, backends,
+# events or schemas folders have some changes (excluding the webapp files).
+if [ -z "$(git log --pretty=oneline $DRONE_COMMIT_AFTER...$DRONE_COMMIT_BEFORE -- platypush/backend platypush/plugins platypush/schemas platypush/message/event ':(exclude)platypush/backend/http/webapp')" ]; then
+  echo 'No changes to the components file'
+  exit 0
+fi
+
+. .drone/macros/configure-ssh.sh
+. .drone/macros/configure-gpg.sh
+
+echo 'Updating components cache'
+apk add --update --no-cache $(cat platypush/install/requirements/alpine.txt)
+pip install . --break-system-packages
+
+python - <<EOF
+from platypush import get_plugin
+
+get_plugin('inspect').refresh_cache(force=True)
+EOF
+
+# Create a .skipci file to mark the fact that the next steps should be skipped
+# (we're going to do another push anyway, so another pipeline will be triggered)
+touch "$SKIPCI"
+
+git add "$CACHEFILE"
+git commit "$CACHEFILE" -S -m "[Automatic] Updated components cache" --no-verify
+git remote rm origin
+git remote add origin git@git.platypush.tech:platypush/platypush.git
+git push -f origin master
+
+# Restore the original git configuration
+mv "$TMP_GIT_CONF" "$GIT_CONF"

.drone/update-deb-packages.sh

@@ -0,0 +1,102 @@
+#!/bin/sh
+
+[ -f .skipci ] && exit 0
+
+echo "-- Copying source directory"
+mkdir -p "$WORKDIR/src"
+export SRCDIR="$WORKDIR/src/$DEB_VERSION"
+cp -r "$PWD" "$SRCDIR"
+cd "$SRCDIR"
+
+echo "-- Installing dependencies"
+apt update
+apt install -y curl dpkg-dev gpg git python3 python3-pip python3-setuptools
+
+echo "--- Parsing metadata"
+git config --global --add safe.directory "$PWD"
+git pull --rebase origin master --tags
+export VERSION=$(python3 setup.py --version)
+export GIT_VERSION="$VERSION-$(git log --pretty=oneline HEAD...v$VERSION | wc -l)"
+export GIT_BUILD_DIR="$WORKDIR/${PKG_NAME}_${GIT_VERSION}_all"
+export GIT_DEB="$WORKDIR/${PKG_NAME}_${GIT_VERSION}_all.deb"
+export POOL_PATH="$APT_ROOT/pool/$DEB_VERSION/dev"
+
+echo "--- Building git package"
+pip install --prefix="$GIT_BUILD_DIR/usr" --no-cache --no-deps .
+
+find "$GIT_BUILD_DIR" -name "site-packages" | while read dir; do
+  base="$(dirname "$dir")"
+  mv "$dir" "$base/dist-packages"
+done
+
+install -m755 -d "${GIT_BUILD_DIR}/usr/lib/systemd/system"
+install -m755 -d "${GIT_BUILD_DIR}/usr/lib/systemd/user"
+install -m750 -d "${GIT_BUILD_DIR}/var/lib/platypush"
+install -m750 -d "${GIT_BUILD_DIR}/etc/platypush/scripts"
+
+install -m644 "${SRCDIR}/platypush/config/config.yaml" "${GIT_BUILD_DIR}/etc/platypush/config.yaml"
+install -m644 "${SRCDIR}/platypush/config/systemd/platypush.service" "${GIT_BUILD_DIR}/usr/lib/systemd/user/platypush.service"
+install -m644 "${SRCDIR}/platypush/config/systemd/platypush.service" "${GIT_BUILD_DIR}/usr/lib/systemd/system/platypush.service"
+sed -i "${GIT_BUILD_DIR}/usr/lib/systemd/system/platypush.service" -r \
+    -e 's/^#\s*Requires=(.*)/Requires=\1/' \
+    -e 's/^\[Service\]$/\[Service\]\
+User=platypush\
+Group=platypush\
+WorkingDirectory=\/var\/lib\/platypush\
+Environment="PLATYPUSH_CONFIG=\/etc\/platypush\/config.yaml"\
+Environment="PLATYPUSH_WORKDIR=\/var\/lib\/platypush"/'
+
+mkdir -p "$GIT_BUILD_DIR/DEBIAN"
+
+cat <<EOF > "$GIT_BUILD_DIR/DEBIAN/control"
+Package: $PKG_NAME
+Version: $GIT_VERSION
+Maintainer: Fabio Manganiello <fabio@platypush.tech>
+Depends: $(cat platypush/install/requirements/debian.txt | tr '\n' ',' | sed -re 's/,$//' -e 's/,/, /g')
+Architecture: all
+Homepage: https://platypush.tech
+Description: Universal command executor and automation hub.
+EOF
+
+cat <<EOF > "$GIT_BUILD_DIR/DEBIAN/postinst" && chmod +x "$GIT_BUILD_DIR/DEBIAN/postinst"
+#!/bin/sh
+
+set -e
+
+if [ "\$1" = "configure" ]; then
+  grep -e '^platypush:' /etc/passwd 2>/dev/null || useradd -U -r -s /bin/false -d /var/lib/platypush platypush
+  mkdir -p /var/lib/platypush
+  chown -R platypush:platypush /var/lib/platypush
+  chown -R platypush:platypush /etc/platypush
+  if which systemctl; then systemctl daemon-reload; fi
+fi
+EOF
+
+mkdir -p "$POOL_PATH"
+rm -f "$POOL_PATH/"*.deb
+dpkg --build "$GIT_BUILD_DIR"
+
+echo "--- Copying $GIT_DEB to $POOL_PATH"
+cp "$GIT_DEB" "$POOL_PATH"
+
+# If main/all/Packages doesn't exist, then we should create the first main release
+[ $(ls "$APT_ROOT/pool/$DEB_VERSION/main/${PKG_NAME}_${VERSION}-"*"_all.deb" 2>/dev/null | wc -l) -eq 0 ] && export UPDATE_STABLE_PKG=1
+
+export PKGURL="https://apt.platypush.tech/dists/$DEB_VERSION/main/all/Packages"
+
+[ -z "$UPDATE_STABLE_PKG" ] &&
+  curl -ILs -o /dev/null -w "%{http_code}" "$PKGURL" |
+    grep -e '^4' >/dev/null && export UPDATE_STABLE_PKG=1
+
+# If the published release version differs from the current one, then we should publish a new main release
+if [ -z "$UPDATE_STABLE_PKG" ]; then
+  RELEASED_VERSION=$(curl -s "$PKGURL" | grep -e '^Version: ' | head -1 | awk '{print $2}' | cut -d- -f 1)
+  [ "$RELEASED_VERSION" != "$VERSION" ] && export UPDATE_STABLE_PKG=1
+fi
+
+# Proceed and update the main release if the version number has changed
+if [ -n "$UPDATE_STABLE_PKG" ]; then
+  echo "--- Updating main package"
+  mkdir -p "$APT_ROOT/pool/$DEB_VERSION/main"
+  cp "$GIT_DEB" "$APT_ROOT/pool/$DEB_VERSION/main/${PKG_NAME}_${VERSION}-1_all.deb"
+fi

.drone/update-pip-package.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+apk add --update --no-cache py3-twine
+python setup.py sdist bdist_wheel
+twine upload dist/platypush-$(python setup.py --version).tar.gz

.drone/update-rpm-repo.sh

@@ -0,0 +1,261 @@
+#!/bin/sh
+
+[ -f .skipci ] && exit 0
+
+echo "-- Installing dependencies"
+yum install -y \
+  createrepo \
+  git \
+  gpg \
+  python \
+  python-pip \
+  python-setuptools \
+  rpm-build \
+  rpm-sign \
+  systemd-rpm-macros \
+  wget \
+  yum-utils \
+
+echo "-- Copying source directory"
+mkdir -p "$WORKDIR"
+export SRCDIR="$WORKDIR/src"
+cp -r "$PWD" "$SRCDIR"
+cd "$SRCDIR"
+mkdir -p "$RPM_ROOT"
+
+echo "--- Parsing metadata"
+git config --global --add safe.directory $PWD
+git pull --rebase origin master --tags
+export VERSION=$(python3 setup.py --version)
+export RELNUM="$(git log --pretty=oneline HEAD...v$VERSION | wc -l)"
+export SPECFILE="$WORKDIR/$PKG_NAME.spec"
+export BUILD_DIR="$WORKDIR/build"
+export TMP_RPM_ROOT="$WORKDIR/repo"
+export SRC_URL="https://git.platypush.tech/platypush/platypush/archive/master.tar.gz"
+
+echo "--- Creating git package spec"
+
+cat <<EOF > $SPECFILE
+Summary: Universal command executor and automation hub.
+Name: $PKG_NAME-git
+Version: $VERSION
+Release: $RELNUM
+URL: https://platypush.tech
+Group: System
+License: MIT
+Packager: Fabio Manganiello <fabio@platypush.tech>
+Source: $SRC_URL
+Requires: $(cat platypush/install/requirements/fedora.txt | tr '\n' ' ')
+Conflicts: $PKG_NAME
+Prefix: %{_prefix}
+BuildRoot: %{_tmppath}/%{name}-root
+BuildRequires: systemd-rpm-macros
+%{?sysusers_requires_compat}
+
+%description
+Universal command executor and automation hub.
+
+%install
+mkdir -p %{buildroot}/
+cp -r "$BUILD_DIR"/* %{buildroot}/
+install -p -Dm0644 "${BUILD_DIR}/usr/lib/sysusers.d/platypush.conf" %{buildroot}%{_sysusersdir}/platypush.conf
+
+%pre
+%sysusers_create_compat "${BUILD_DIR}/usr/lib/sysusers.d/platypush.conf"
+
+%clean
+
+%files
+%defattr(750,platypush,platypush,750)
+%dir /etc/platypush
+/etc/platypush/*
+/usr/bin/*
+/usr/lib/python$(python3 --version | awk '{print $2}' | cut -d. -f 1,2)/site-packages/platypush
+/usr/lib/python$(python3 --version | awk '{print $2}' | cut -d. -f 1,2)/site-packages/platypush-$VERSION.dist-info
+/usr/lib/systemd/system/*
+/usr/lib/systemd/user/*
+%defattr(750,platypush,platypush,750)
+%dir /var/lib/platypush
+%{_sysusersdir}/platypush.conf
+
+%changelog
+* $(date +'%a %b %d %Y') admin <admin@platypush.tech>
+- [Automatic] Release $VERSION-$RELNUM
+EOF
+
+echo "--- Building git package"
+mkdir -p "$BUILD_DIR"
+
+pip install --prefix="$BUILD_DIR/usr" --no-cache --no-deps .
+
+install -m755 -d "${BUILD_DIR}/usr/lib/systemd/system"
+install -m755 -d "${BUILD_DIR}/usr/lib/systemd/user"
+install -m755 -d "${BUILD_DIR}/usr/lib/sysusers.d"
+install -m750 -d "${BUILD_DIR}/var/lib/platypush"
+install -m750 -d "${BUILD_DIR}/etc/platypush/scripts"
+
+install -m644 "${SRCDIR}/platypush/config/config.yaml" "${BUILD_DIR}/etc/platypush/config.yaml"
+install -Dm644 "${SRCDIR}/platypush/config/systemd/platypush-sysusers.conf" "${BUILD_DIR}/usr/lib/sysusers.d/platypush.conf"
+install -m644 "${SRCDIR}/platypush/config/systemd/platypush.service" "${BUILD_DIR}/usr/lib/systemd/user/platypush.service"
+install -m644 "${SRCDIR}/platypush/config/systemd/platypush.service" "${BUILD_DIR}/usr/lib/systemd/system/platypush.service"
+sed -i "${BUILD_DIR}/usr/lib/systemd/system/platypush.service" -r \
+    -e 's/^#\s*Requires=(.*)/Requires=\1/' \
+    -e 's/^\[Service\]$/\[Service\]\
+User=platypush\
+Group=platypush\
+WorkingDirectory=\/var\/lib\/platypush\
+Environment="PLATYPUSH_CONFIG=\/etc\/platypush\/config.yaml"\
+Environment="PLATYPUSH_WORKDIR=\/var\/lib\/platypush"/'
+
+rpmbuild --target "noarch" -bb "$SPECFILE"
+
+echo "--- Copying the new RPM package"
+mkdir -p "$TMP_RPM_ROOT"
+cp "$HOME/rpmbuild/RPMS/noarch/$PKG_NAME-git-$VERSION-$RELNUM.noarch.rpm" "$TMP_RPM_ROOT"
+
+echo "--- Checking the latest released stable version"
+export LATEST_STABLE_PKG=$(ls -rt "$RPM_ROOT/$PKG_NAME"*.rpm 2>/dev/null | grep -v "$PKG_NAME-git" | tail -1)
+
+if [ -z "$LATEST_STABLE_PKG" ]; then
+  # If not stable release is available, then create one
+  export UPDATE_STABLE_PKG=1
+else
+  # Otherwise, create a new release if the reported version on the repo is different
+  # from the latest released version.
+  export LATEST_STABLE_VERSION=$(basename $LATEST_STABLE_PKG | cut -d- -f 2)
+  if [ "$VERSION" != "$LATEST_STABLE_VERSION" ]; then
+    export UPDATE_STABLE_PKG=1
+  else
+    # If the version has remained the same, then simply copy the existing RPM to the
+    # new repository directory.
+    echo "Copying the existing release $LATEST_STABLE_VERSION to the new repository"
+    cp "$LATEST_STABLE_PKG" "$TMP_RPM_ROOT"
+  fi
+fi
+
+# If a new stable release is required, build another RPM
+if [ -n "$UPDATE_STABLE_PKG" ]; then
+  export RELNUM=1
+  export SRC_URL="https://git.platypush.tech/platypush/platypush/archive/v$VERSION.tar.gz"
+
+  cat <<EOF > $SPECFILE
+Summary: Universal command executor and automation hub.
+Name: $PKG_NAME
+Version: $VERSION
+Release: $RELNUM
+URL: https://platypush.tech
+Group: System
+License: MIT
+Packager: Fabio Manganiello <fabio@platypush.tech>
+Source: $SRC_URL
+Requires: $(cat platypush/install/requirements/fedora.txt | tr '\n' ' ')
+Conflicts: $PKG_NAME-git
+Prefix: %{_prefix}
+BuildRoot: %{_tmppath}/%{name}-root
+BuildRequires: systemd-rpm-macros
+%{?sysusers_requires_compat}
+
+%description
+Universal command executor and automation hub.
+
+%install
+mkdir -p %{buildroot}/
+cp -r "$BUILD_DIR"/* %{buildroot}/
+install -p -Dm0644 "${BUILD_DIR}/usr/lib/sysusers.d/platypush.conf" %{buildroot}%{_sysusersdir}/platypush.conf
+
+%pre
+%sysusers_create_compat "${BUILD_DIR}/usr/lib/sysusers.d/platypush.conf"
+
+%clean
+
+%files
+%defattr(750,platypush,platypush,750)
+%dir /etc/platypush
+/etc/platypush/*
+/usr/bin/*
+/usr/lib/python$(python3 --version | awk '{print $2}' | cut -d. -f 1,2)/site-packages/platypush
+/usr/lib/python$(python3 --version | awk '{print $2}' | cut -d. -f 1,2)/site-packages/platypush-$VERSION.dist-info
+/usr/lib/systemd/system/*
+/usr/lib/systemd/user/*
+%defattr(750,platypush,platypush,750)
+%dir /var/lib/platypush
+%{_sysusersdir}/platypush.conf
+
+%changelog
+* $(date +'%a %b %d %Y') admin <admin@platypush.tech>
+- [Automatic] Release $VERSION-$RELNUM
+EOF
+
+  echo "--- Building package for stable release $VERSION"
+  rpmbuild --target "noarch" -bb "$SPECFILE"
+  cp "$HOME/rpmbuild/RPMS/noarch/$PKG_NAME-$VERSION-$RELNUM.noarch.rpm" "$TMP_RPM_ROOT"
+fi
+
+echo "--- Importing the repository keys"
+cat <<EOF | gpg --import --armor
+$PGP_PRIVKEY
+EOF
+
+export PGP_KEYID=$(echo "$PGP_PUBKEY" | gpg --with-colons --import-options show-only --import --fingerprint | grep -e '^fpr:' | head -1 | awk -F ':' '{print $(NF - 1)}')
+cat <<EOF > $HOME/.rpmmacros
+%signature gpg
+%_gpg_name $PGP_KEYID
+EOF
+
+echo "--- Signing the new RPM packages"
+rpm --addsign "$TMP_RPM_ROOT"/*.rpm
+
+echo "--- Creating a new copy of the RPM repository"
+createrepo "$TMP_RPM_ROOT"
+gpg --detach-sign --armor "$TMP_RPM_ROOT/repodata/repomd.xml"
+
+cat <<EOF > "$TMP_RPM_ROOT/platypush.repo"
+[platypush]
+name=Platypush repository
+baseurl=https://rpm.platypush.tech
+enabled=1
+type=rpm
+gpgcheck=1
+gpgkey=https://rpm.platypush.tech/pubkey.txt
+EOF
+
+cat <<EOF > "$TMP_RPM_ROOT/index.txt"
+Welcome to the Platypush RPM repository!
+
+Project homepage: https://platypush.tech
+Source code: https://git.platypush.tech/platypush/platypush
+Documentation / API reference: https://docs.platypush.tech
+
+You can use this RPM repository to install Platypush on Fedora or other
+RPM-based distros - as long as they are compatible with the latest Fedora
+release.
+
+Steps:
+
+1. Add the repository to your sources
+=====================================
+
+$ sudo yum config-manager --add-repo https://rpm.platypush.tech/platypush.repo
+
+2. Install Platypush
+====================
+
+$ sudo yum install platypush
+
+Or, if you want to install a version always up-to-date with the git repo:
+
+$ sudo yum install platypush-git
+EOF
+
+cat <<EOF > "$TMP_RPM_ROOT/pubkey.txt"
+$PGP_PUBKEY
+EOF
+
+echo "--- Updating the repository"
+export NEW_RPM_ROOT="$REPOS_ROOT/rpm_new"
+export OLD_RPM_ROOT="$REPOS_ROOT/rpm_old"
+cp -r "$TMP_RPM_ROOT" "$NEW_RPM_ROOT"
+rm -rf "$TMP_RPM_ROOT"
+mv "$RPM_ROOT" "$OLD_RPM_ROOT"
+mv "$NEW_RPM_ROOT" "$RPM_ROOT"
+rm -rf "$OLD_RPM_ROOT"

.gitignore

@@ -10,7 +10,7 @@ package.sh
 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
@@ -24,3 +24,7 @@ coverage.xml
 Session.vim
 /jsconfig.json
 /package.json
+/Dockerfile
+/docs/source/wiki
+/.skipci
+dump.rdb

.gitlab-ci.yml

@@ -1,72 +0,0 @@
-sync-to-github:
-  stage: build
-  script:
-    - echo "Synchronizing repo state to Github"
-    - export REPO_DIR="$(mktemp -d /tmp/platypush-XXXXX)"
-    - git clone git@git.platypush.tech:platypush/platypush.git "$REPO_DIR"
-    - cd "$REPO_DIR"
-    - git remote add github git@github.com:/BlackLight/platypush.git
-    - git checkout $CI_COMMIT_BRANCH
-    - git pull
-    - git push --mirror -v github
-
-run-tests:
-  stage: test
-  script:
-    - ./.gitlab/run_ci_tests.sh
-
-rebuild-docs:
-  stage: deploy
-  only:
-    - master
-  script:
-    - ./.gitlab/rebuild_docs.sh
-
-update-aur-packages:
-  stage: deploy
-  only:
-    - master
-    - tags
-  script:
-    - echo "Updating AUR packages"
-    - export REPO_DIR="$(mktemp -d /tmp/platypush-distutils-XXXXX)"
-    - git clone git@fabiomanganiello.com:/home/git/platypush-distutils.git "$REPO_DIR"
-    - cd "$REPO_DIR"
-    - git submodule init
-    - git submodule update
-    - cd distro/arch/git
-    - git checkout master
-    - git pull --rebase
-    - cd ../../../
-    - cd distro/arch/stable
-    - git checkout master
-    - git pull --rebase
-    - cd ../../../
-    - ./update.sh
-    - cd distro/arch/git
-    - changes="$(git status --porcelain --untracked-files=no)"
-    - "[[ -n \"$changes\" ]] && git commit -a -m '[Automatic] Package updated' && git push || echo 'No changes'"
-    - cd ../../../
-    - cd distro/arch/stable
-    - changes="$(git status --porcelain --untracked-files=no)"
-    - "[[ -n \"$changes\" ]] && git commit -a -m '[Automatic] Package updated' && git push || echo 'No changes'"
-
-upload-pip-package:
-  stage: deploy
-  only:
-    - tags
-  script:
-    # Update the CI/CD configuration
-    - cd ~/platypush-ci-cd
-    - git pull
-    - cd -
-    # Build the package
-    - rm -rf build dist *.egg-info
-    - export VERSION=$(grep -e '^\s*__version__\s*=' platypush/__init__.py | sed -r -e 's/^\s*__version__\s*=\s*.(.+?).\s*$/\1/')
-    - source ~/.credentials/pypi.env
-    - python setup.py sdist bdist_wheel
-    # Upload to PyPI
-    - twine upload --repository platypush ./dist/platypush-${VERSION}.tar.gz
-    # Upload to the local package repository
-    - TWINE_USERNAME=$LOCAL_TWINE_USERNAME TWINE_PASSWORD=$LOCAL_TWINE_PASSWORD twine upload --repository-url https://git.platypush.tech/api/v4/projects/3/packages/pypi dist/platypush-${VERSION}.tar.gz
-

.gitlab/rebuild_docs.sh

@@ -1,33 +0,0 @@
-#!/bin/bash
-
-LOGFILE="./docs.log"
-STATUS_IMG_PATH="./docs-status.svg"
-
-build_docs() {
-    cd ./docs || exit 1
-    make html 2>&1 | tee "../$LOGFILE"
-    ret=$?
-    cd .. || exit 1
-    return $?
-}
-
-########
-# MAIN #
-########
-
-build_docs
-ret=$?
-
-log_base_path="$(date +/opt/tests/platypush/logs/docs/%Y-%m-%dT%H:%M:%S.%m)"
-if [[ $ret == 0 ]]; then
-    wget -O "$STATUS_IMG_PATH" https://ci.platypush.tech/docs/passed.svg
-    cp "$LOGFILE" "${log_base_path}_PASSED.log"
-else
-    wget -O "$STATUS_IMG_PATH" https://ci.platypush.tech/docs/failed.svg
-    cp "$LOGFILE" "${log_base_path}_FAILED.log"
-fi
-
-mv "$STATUS_IMG_PATH" /opt/tests/platypush/logs/docs/
-mv "$LOGFILE" /opt/tests/platypush/logs/latest.log
-cp -r docs/build/html /opt/repos/platypush/docs/build/
-exit $ret

.gitlab/run_ci_tests.sh

@@ -1,60 +0,0 @@
-#!/bin/bash
-
-BASE_DIR="$(mktemp -d '/tmp/platypush-ci-tests-XXXXX')"
-VENV_DIR="$BASE_DIR/venv"
-TEST_LOG="./test.log"
-STATUS_IMG_PATH="./status.svg"
-
-cleanup() {
-    echo "Cleaning up environment"
-    rm -rf "$BASE_DIR"
-}
-
-prepare_venv() {
-    echo "Preparing virtual environment"
-    python -m venv "$VENV_DIR"
-    cd "$VENV_DIR" || exit 1
-    source ./bin/activate
-    cd - || exit 1
-}
-
-install_repo() {
-    echo "Installing latest version of the repository"
-    pip install '.[http]'
-}
-
-run_tests() {
-    echo "Running tests"
-    pytest 2>&1 | tee "$TEST_LOG"
-    deactivate
-
-    if grep -e '^FAILED ' "$TEST_LOG"; then
-      return 2
-    fi
-
-    return 0  # PASSED
-}
-
-########
-# MAIN #
-########
-
-cleanup
-prepare_venv
-install_repo
-run_tests
-ret=$?
-cleanup
-
-log_base_path="$(date +/opt/tests/platypush/logs/%Y-%m-%dT%H:%M:%S.%m)"
-if [[ $ret == 0 ]]; then
-    wget -O "$STATUS_IMG_PATH" https://ci.platypush.tech/passed.svg
-    cp "$TEST_LOG" "${log_base_path}_PASSED.log"
-else
-    wget -O "$STATUS_IMG_PATH" https://ci.platypush.tech/failed.svg
-    cp "$TEST_LOG" "${log_base_path}_FAILED.log"
-fi
-
-mv "$STATUS_IMG_PATH" /opt/tests/platypush/logs/status.svg
-mv "$TEST_LOG" /opt/tests/platypush/logs/latest.log
-exit $ret

CONTRIBUTING.md

@@ -27,13 +27,9 @@ Guidelines:
   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 class docstring (see other plugins and backends for examples).
-  - In [`setup.py`](https://git.platypush.tech/platypush/platypush/-/blob/master/setup.py#L72) as
-    an `extras_require` entry.
-  - In the plugin/backend class pydoc string.
-  - In the `manifest.yaml` - 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.
+- 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.

MANIFEST.in

@@ -1,4 +1,7 @@
 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.yaml
+include platypush/config/systemd/*
+global-include manifest.json
+global-include components.json.gz

README.md

@@ -1,8 +1,7 @@
 Platypush
 =========
 
-[![Build Status](https://ci.platypush.tech/status.svg)](https://ci.platypush.tech/latest.log)
-[![Documentation Status](https://ci.platypush.tech/docs/status.svg)](https://ci.platypush.tech/docs/latest.log)
+[![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)
@@ -11,20 +10,22 @@ Platypush
 
 <!-- toc -->
 
-- [Useful links](#useful-links)
 - [Introduction](#introduction)
     + [What it can do](#what-it-can-do)
 - [Installation](#installation)
-  * [System installation](#system-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)
+  * [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.yaml`](#install-via-manifestyaml)
+    + [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)
+  * [Docker installation](#docker-installation-1)
 - [Architecture](#architecture)
   * [Plugins](#plugins)
   * [Actions](#actions)
@@ -44,31 +45,11 @@ Platypush
     + [PWA support](#pwa-support)
 - [Mobile app](#mobile-app)
 - [Tests](#tests)
+- [Useful links](#useful-links)
 - [Funding](#funding)
 
 <!-- tocstop -->
 
-## 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.
-
-- A [Reddit channel](https://www.reddit.com/r/platypush) is available for
-  general questions.
-
 ## Introduction
 
 Platypush is a general-purpose extensible platform for automation across
@@ -124,26 +105,82 @@ You can use Platypush to do things like:
 
 ## Installation
 
-### System installation
+### Prerequisites
 
-Platypush uses Redis to deliver and store requests and temporary messages:
+Platypush uses [Redis](https://redis.io/) to dispatch requests, responses,
+events and custom messages across several processes and integrations.
+
+#### Docker installation
+
+You can run Redis on the fly on your local machine using a Docker image:
+
+```bash
+# Expose a Redis server on port 6379 (default)
+docker run --rm -p 6379:6379 --name redis redis
+```
+
+#### 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
-# Example for Debian-based distributions
-[sudo] apt-get install redis-server
+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
+sudo systemctl enable redis
+sudo systemctl start redis
 ```
 
-#### Install through `pip`
+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).
 
-```shell
-[sudo] pip3 install platypush
+### Install through `pip`
+
+```bash
+[sudo] pip install platypush
 ```
 
-#### Install through a system package manager
+### Install through a system package manager
 
 Note: currently only Arch Linux and derived distributions are supported.
 
@@ -154,7 +191,7 @@ latest stable version) or the
 (for the latest git version) through your favourite AUR package manager. For
 example, using `yay`:
 
-```shell
+```bash
 yay platypush
 # Or
 yay platypush-git
@@ -163,14 +200,12 @@ yay platypush-git
 The Arch Linux packages on AUR are automatically updated upon new git commits
 or tags.
 
-#### Install from sources
+### Install from sources
 
 ```shell
 git clone https://git.platypush.tech/platypush/platypush.git
 cd platypush
 [sudo] pip install .
-# Or
-[sudo] python3 setup.py install
 ```
 
 ### Installing the dependencies for your extensions
@@ -181,16 +216,27 @@ ways to check the dependencies required by an extension:
 
 #### Install via `extras` name
 
-All the extensions that require extra dependencies are listed in the
-[`extras_require` section under
-`setup.py`](https://git.platypush.tech/platypush/platypush/src/branch/master/setup.py#L84).
+You can install extra dependencies via pip extras:
 
-#### Install via `manifest.yaml`
+```shell
+pip install 'platypush[plugin1,plugin2,...]'
+```
 
-All the plugins and backends have a `manifest.yaml` file in their source folder.
+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.yaml` way to discover the
+If you followed the `extras` or `manifest.json` way to discover the
 dependencies, then you can install them in two ways:
 
 1. `pip` installation:
@@ -224,6 +270,8 @@ You can then start the service by simply running:
 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)
@@ -382,9 +430,7 @@ 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),
-[Pushbullet](https://docs.platypush.tech/en/latest/platypush/backend/pushbullet.html)
-etc.).
+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.
@@ -470,11 +516,10 @@ event.hook.SearchSongVoiceCommand:
   [Example](https://git.platypush.tech/platypush/platypush/src/branch/master/examples/conf/hook.py):
 
 ```python
-from platypush.event.hook import hook
-from platypush.utils import run
+from platypush import run, when
 from platypush.message.event.assistant import SpeechRecognizedEvent
 
-@hook(SpeechRecognizedEvent, phrase='play ${title} by ${artist}')
+@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,
@@ -492,22 +537,22 @@ against partial event arguments are also possible, and relational operators are
 supported as well. For example:
 
 ```python
-from platypush.event.hook import hook
+from platypush import when
 from platypush.message.event.sensor import SensorDataChangeEvent
 
-@hook(SensorDataChangeEvent, data=1):
+@when(SensorDataChangeEvent, data=1):
 def hook_1(event):
     """
     Triggered when event.data == 1
     """
 
-@hook(SensorDataChangeEvent, data={'state': 1}):
+@when(SensorDataChangeEvent, data={'state': 1}):
 def hook_2(event):
     """
     Triggered when event.data['state'] == 1
     """
 
-@hook(SensorDataChangeEvent, data={
+@when(SensorDataChangeEvent, data={
   'temperature': {'$gt': 25},
   'humidity': {'$le': 15}
 }):
@@ -528,9 +573,7 @@ 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` - provided that the procedure is also
-imported in `~/.config/platypush/scripts/__init__.py` so it can be discovered
-by the service.
+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
@@ -670,8 +713,6 @@ 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.
 
-Some screenshots:
-
 #### The main web panel
 
 This is the default panel available at `http://<host>:<port>` after
@@ -751,6 +792,30 @@ of Platypush to your fingertips.
 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

bin/platypush

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

bin/platyvenv

@@ -1,249 +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 <fabio@platypush.tech>                          #
-# @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"
-    pip_cmd=
-    pkg_cmd=
-    includes=()
-    cmd_exec=()
-
-    while read -r line; do
-      if echo "$line" | grep -E "^pip:\s*"; then
-        pip_cmd="$(echo "$line" | sed -r -e 's/^pip:\s*(.*)'/\\1/)"
-      elif echo "$line" | grep -E "^packages:\s*"; then
-        pkg_cmd="$(echo "$line" | sed -r -e 's/^packages:\s*(.*)'/\\1/)"
-      elif echo "$line" | grep -E "^exec:\s*"; then
-        cmd_exec+=("$(echo "$line" | sed -r -e 's/^exec:\s*(.*)'/\\1/)")
-      elif echo "$line" | grep -E "^include:\s*"; then
-        includes+=("$(echo "$line" | sed -r -e 's/^include:\s*(.*)'/\\1/)")
-      elif echo "$line" | grep -E "^device_id:\s*"; then
-        device_id="$(echo "$line" | sed -r -e 's/^device_id:\s*(.*)'/\\1/)"
-      fi
-    done <<< "$(python <<EOF
-from platypush.config import Config
-from platypush.utils.manifest import get_install_commands_from_conf
-
-deps = get_install_commands_from_conf('$(realpath "${cfgfile}")')
-print(f'device_id: {Config.get("device_id")}')
-
-if deps.get('pip'):
-    print(f'pip: {deps["pip"]}')
-
-if deps.get('packages'):
-    print(f'packages: {deps["packages"]}')
-
-for cmd in deps.get('exec', []):
-    print(f'exec: {cmd}')
-
-for include in Config._included_files:
-    print(f'include: {include}')
-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}" || exit 1
-    source "${envdir}/bin/activate"
-
-    echo "Installing required dependencies"
-    # shellcheck disable=SC2086
-    [ -n "${pkg_cmd}" ] && sudo ${pkg_cmd}
-    [ -n "${pip_cmd}" ] && ${pip_cmd}
-
-    for ((i=0; i < ${#cmd_exec[@]}; i++)); do
-        ${cmd_exec[$i]}
-    done
-
-    pip install --upgrade git+https://git.platypush.tech/platypush/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}"
-    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 "${rundir}"
-
-    if [[ -f "$pidfile" ]]; then
-        if pgrep -F "${pidfile}"; then
-            echo "Another instance (PID $(cat "${pidfile}")) is running, please stop that instance first"
-            exit 1
-        fi
-
-        echo "A PID file was found but the process does not seem to be running, starting anyway"
-        rm -f "$pidfile"
-    fi
-
-    python3 -m venv "${envdir}"
-    cd "${envdir}" || exit 1
-    source bin/activate
-    bin/platypush -c "$cfgfile" -P "$pidfile" &
-    start_time=$(date +'%s')
-    timeout=30
-
-    while :; do
-        [[ -f "$pidfile" ]] && break
-        now=$(date +'%s')
-        elapsed=$(( now-start_time ))
-        if (( elapsed >= timeout )); then
-            echo "Platypush instance '$env' did not 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"
-    wait "${pid}"
-    echo "Platypush environment $env terminated"
-}
-
-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")"
-    # shellcheck disable=SC2086
-    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 pgrep -F "${pidfile}"; then
-            echo "Another instance (PID $(cat "$pidfile")) is running, please stop that instance first"
-            exit 1
-        fi
-
-        echo "A PID file was found but the process does not seem to be running, removing anyway"
-    fi
-
-    echo "WARNING: This operation will permanently remove the Platypush environment $1"
-    echo -n "Are you sure you want to continue? (y/N) "
-    IFS= read -r answer
-    echo "$answer" | grep -E '^[yY]' >/dev/null || exit 0
-    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}"
-
-# shellcheck disable=SC2048,SC2086
-case ${action} in
-    'build') build $*;;
-    'start') start $*;;
-    'stop') stop $*;;
-    'rm') rme $*;;
-    *) usage;;
-esac

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/_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

@@ -6,55 +6,7 @@ Backends
     :maxdepth: 1
     :caption: Backends:
 
-    platypush/backend/adafruit.io.rst
-    platypush/backend/alarm.rst
-    platypush/backend/assistant.google.rst
-    platypush/backend/assistant.snowboy.rst
-    platypush/backend/button.flic.rst
-    platypush/backend/camera.pi.rst
-    platypush/backend/chat.telegram.rst
-    platypush/backend/covid19.rst
-    platypush/backend/file.monitor.rst
-    platypush/backend/foursquare.rst
-    platypush/backend/github.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/joystick.jstest.rst
-    platypush/backend/joystick.linux.rst
-    platypush/backend/kafka.rst
-    platypush/backend/light.hue.rst
-    platypush/backend/log.http.rst
-    platypush/backend/mail.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/music.spotify.rst
-    platypush/backend/nextcloud.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.ir.zeroborg.rst
-    platypush/backend/sensor.leap.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/weather.openweathermap.rst
-    platypush/backend/wiimote.rst
-    platypush/backend/zwave.rst
-    platypush/backend/zwave.mqtt.rst

docs/source/conf.py

@@ -15,17 +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-2021, Fabio Manganiello'
-author = 'Fabio Manganiello'
+copyright = '2017-2023, Fabio Manganiello'
+author = 'Fabio Manganiello <fabio@manganiello.tech>'
 
 # The short X.Y version
 version = ''
@@ -43,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',
@@ -52,6 +50,7 @@ extensions = [
     'sphinx.ext.githubpages',
     'sphinx_rtd_theme',
     'sphinx_marshmallow',
+    'add_dependencies',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -60,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'
@@ -113,7 +112,14 @@ html_theme_options = {
 # 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.
@@ -165,9 +171,9 @@ latex_documents = [
 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 = [
@@ -190,136 +196,30 @@ texinfo_documents = [
 # Example configuration for intersphinx: refer to the Python standard library.
 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_default_options = {
     'members': True,
     'show-inheritance': True,
 }
 
-autodoc_mock_imports = [
-    'gunicorn',
-    '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',
-    'pyclip',
-    'pydbus',
-    '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',
-    'pmw3901',
-    'PIL',
-    'croniter',
-    'pyaudio',
-    'avs',
-    'PyOBEX',
-    'PyOBEX.client',
-    'todoist',
-    'trello',
-    'telegram',
-    'telegram.ext',
-    'pyfirmata2',
-    'cups',
-    'graphyte',
-    'cpuinfo',
-    'psutil',
-    'openzwave',
-    'deepspeech',
-    'wave',
-    'pvporcupine ',
-    'pvcheetah',
-    'pyotp',
-    'linode_api4',
-    'pyzbar',
-    'tensorflow',
-    'keras',
-    'pandas',
-    'samsungtvws',
-    'paramiko',
-    'luma',
-    'zeroconf',
-    'dbus',
-    'gi',
-    'gi.repository',
-    'twilio',
-    'Adafruit_Python_DHT',
-    'RPi.GPIO',
-    'RPLCD',
-    'imapclient',
-    'pysmartthings',
-    'aiohttp',
-    'watchdog',
-    'pyngrok',
-    'irc',
-    'irc.bot',
-    'irc.strings',
-    'irc.client',
-    'irc.connection',
-    'irc.events',
-    'defusedxml',
-    'nio',
-    'aiofiles',
-    'aiofiles.os',
-    'async_lru',
-    'bleak',
-    'bluetooth_numbers',
-    'TheengsDecoder',
-    'simple_websocket',
-    'uvicorn',
-    'websockets',
-    'docutils',
-    'aioxmpp',
-]
-
 sys.path.insert(0, os.path.abspath('../..'))
 
+from platypush.utils.mock.modules import mock_imports  # noqa
 
-def skip(app, what, name, obj, skip, options):
+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)
+    app.connect("autodoc-skip-member", _skip)
 
 
 # vim:sw=4:ts=4:et:

docs/source/events.rst

@@ -11,22 +11,19 @@ Events
     platypush/events/application.rst
     platypush/events/assistant.rst
     platypush/events/bluetooth.rst
-    platypush/events/button.flic.rst
     platypush/events/camera.rst
     platypush/events/chat.slack.rst
-    platypush/events/chat.telegram.rst
     platypush/events/clipboard.rst
-    platypush/events/covid19.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
@@ -67,17 +64,15 @@ Events
     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/websocket.rst
-    platypush/events/wiimote.rst
     platypush/events/xmpp.rst
     platypush/events/zeroborg.rst
     platypush/events/zeroconf.rst

docs/source/index.rst

@@ -1,28 +1,55 @@
 Platypush
 #########
 
-Welcome to the Platypush reference of available plugins, backends and event types.
+Description
+===========
 
-For more information on Platypush check out:
+This is the main documentation hub for Platypush. It includes both the wiki and
+the complete reference of the available integrations.
 
-* The `main page`_ of the project
-* The `Gitea page`_ of the project
-* The `online wiki`_ for quickstart and examples
-* The `Blog articles`_ for inspiration on use-cases 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.
 
-.. _main page: https://platypush.tech
-.. _Gitea page: https://git.platypush.tech/platypush/platypush
-.. _online wiki: https://git.platypush.tech/platypush/platypush/wiki
-.. _Blog articles: https://blog.platypush.tech
+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
+
+    wiki/index
+    wiki/Installation
+    wiki/Configuration
+    wiki/Installing-extensions
+    wiki/A-configuration-example
+    wiki/The-Web-interface
+
+Reference
+=========
 
 .. toctree::
     :maxdepth: 2
-    :caption: Contents:
 
     backends
     plugins
     events
-    responses
 
 Indices and tables
 ==================

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

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

docs/source/platypush/backend/alarm.rst

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

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

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

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

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

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

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

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

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

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

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

docs/source/platypush/backend/covid19.rst

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

docs/source/platypush/backend/file.monitor.rst

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

docs/source/platypush/backend/foursquare.rst

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

docs/source/platypush/backend/github.rst

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

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

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

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

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

docs/source/platypush/backend/gps.rst

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

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

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

docs/source/platypush/backend/inotify.rst

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

docs/source/platypush/backend/joystick.jstest.rst

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

docs/source/platypush/backend/joystick.linux.rst

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

docs/source/platypush/backend/joystick.rst

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

docs/source/platypush/backend/kafka.rst

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

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

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

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

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

docs/source/platypush/backend/mail.rst

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

docs/source/platypush/backend/midi.rst

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

docs/source/platypush/backend/mqtt.rst

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

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

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

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

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

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

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

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

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

docs/source/platypush/backend/nextcloud.rst

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

docs/source/platypush/backend/nfc.rst

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

docs/source/platypush/backend/ping.rst

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

docs/source/platypush/backend/pushbullet.rst

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

docs/source/platypush/backend/scard.rst

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

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

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

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

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

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

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

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

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

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

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

docs/source/platypush/backend/todoist.rst

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

docs/source/platypush/backend/travisci.rst

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

docs/source/platypush/backend/trello.rst

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

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

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

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

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

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

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

docs/source/platypush/backend/wiimote.rst

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

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

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

docs/source/platypush/backend/zwave.rst

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

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

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

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

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

docs/source/platypush/events/covid19.rst

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

docs/source/platypush/events/flic.rst

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

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

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

docs/source/platypush/events/telegram.rst

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

docs/source/platypush/events/todoist.rst

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

docs/source/platypush/events/travisci.rst

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

docs/source/platypush/events/wiimote.rst

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

docs/source/platypush/events/xmpp.rst

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

docs/source/platypush/plugins/application.rst

@@ -0,0 +1,5 @@
+``application``
+===============
+
+.. automodule:: platypush.plugins.application
+    :members:

docs/source/platypush/plugins/assistant.echo.rst

@@ -1,6 +0,0 @@
-``assistant.echo``
-====================================
-
-.. automodule:: platypush.plugins.assistant.echo
-    :members:
-

docs/source/platypush/plugins/assistant.google.pushtotalk.rst

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

docs/source/platypush/plugins/assistant.picovoice.rst

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

docs/source/platypush/plugins/camera.pi.legacy.rst

@@ -0,0 +1,5 @@
+``camera.pi.legacy``
+====================
+
+.. automodule:: platypush.plugins.camera.pi.legacy
+    :members:

docs/source/platypush/plugins/chat.irc.rst

@@ -1,5 +0,0 @@
-``chat.irc``
-============
-
-.. automodule:: platypush.plugins.chat.irc
-    :members:

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

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

docs/source/platypush/plugins/covid19.rst

@@ -1,5 +0,0 @@
-``covid19``
-=============================
-
-.. automodule:: platypush.plugins.covid19
-    :members:

docs/source/platypush/plugins/cups.rst

@@ -0,0 +1,5 @@
+``cups``
+========
+
+.. automodule:: platypush.plugins.cups
+    :members:

docs/source/platypush/plugins/file.monitor.rst

@@ -0,0 +1,5 @@
+``file.monitor``
+================
+
+.. automodule:: platypush.plugins.file.monitor
+    :members: