[Automatic] Updated UI files

[Snyk] Upgrade vue-router from 4.5.0 to 4.5.1

.drone.yml

@@ -8,6 +8,14 @@ volumes:
     host:
       path: /opt/docs/platypush
 
+  - name: repos
+    host:
+      path: /opt/repos/platypush
+
+  - name: docker_sock
+    host:
+      path: /var/run/docker.sock
+
 steps:
 
 ###
@@ -23,19 +31,7 @@ steps:
       from_secret: ssh_privkey
 
   commands:
-    - apk add --update --no-cache git openssh
+    - . .drone/github-mirror.sh
-    - 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 github.com >> ~/.ssh/known_hosts 2>/dev/null
-    - git config --global --add safe.directory $PWD
-    - 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"
-    - git push --all -v github
 
 ###
 ### Rebuild the docs
@@ -48,24 +44,7 @@ steps:
       path: /docs
 
   commands:
-    - echo "Installing required build dependencies"
+    - . .drone/rebuild-docs.sh
-    - apk add --update --no-cache make py3-sphinx py3-pip py3-paho-mqtt py3-yaml
-    - pip install -U hid sphinx-rtd-theme sphinx-book-theme
-    - pip install .
-    - mkdir -p /docs/current
-    - export APPDIR=$PWD
-    - rm -rf "$APPDIR/docs/build"
-    - echo "Building the updated documentation"
-    - 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
 
   when:
     event:
@@ -76,15 +55,9 @@ steps:
 ###
 
 - name: tests
-  image: python:3.11-alpine
+  image: alpine
   commands:
-    - apk add --update --no-cache redis
+    - . .drone/run-tests.sh
-    - apk add --update --no-cache --virtual build-base g++ rust linux-headers
-    - pip install -U pip
-    - pip install .
-    - pip install -r requirements-tests.txt
-    - apk del build-base g++ rust linux-headers
-    - pytest tests
 
 ###
 ### Rebuild the UI files
@@ -113,68 +86,70 @@ steps:
     - tests
 
   commands:
-    - apk add --update --no-cache git
+    - . .drone/build-ui.sh
-
-    # Backup the original git configuration before changing attributes
-    - export GIT_CONF=$PWD/.git/config
-    - cp $GIT_CONF /tmp/git.config.orig
-
-    - git config --global --add safe.directory $PWD
-    - 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 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
-
-    - apk add --update --no-cache bash gnupg openssh
-    - mkdir -p ~/.ssh
-    - |
-      cat <<EOF | gpg --import --armor
-      $PGP_KEY
-      EOF
-
-    - 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
-
-    - git config user.name "Platypush CI/CD Automation"
-    - git config user.email "admin@platypush.tech"
-    - git config commit.gpgsign true
-    - git config user.signingkey $PGP_KEY_ID
-    - 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 origin master
-
-    # Restore the original git configuration
-    - mv /tmp/git.config.orig $GIT_CONF
 
 ###
-### Update the Arch packages
+### Regenerate the components.json cache
 ###
 
-- name: update-arch-packages
+- 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 git package
+### Note: This is probably no longer required, as the platypush-git PKGBUILD
+### #now includes a dynamic pkgver() function.
+### See https://aur.archlinux.org/packages/platypush-git#comment-982845
+###
+
+# - name: update-arch-git-package
+#   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-git-package.sh
+
+###
+### Update the Arch stable package
+###
+
+- name: update-arch-stable-package
   image: python:3.11-alpine
   environment:
     WORKDIR: /tmp/workdir
@@ -184,85 +159,11 @@ steps:
       from_secret: ssh_privkey
 
   when:
-    branch:
-      - master
     event:
-      - push
+      - tag
-
-  depends_on:
-    - build-ui
 
   commands:
-    - echo "-- Installing dependencies"
+    - . .drone/update-arch-stable-package.sh
-    - apk add --update --no-cache curl git openssh pacman sudo
-
-    - echo "--- Parsing metadata"
-    - git config --global --add safe.directory $PWD
-    - 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).$HEAD"
-    - export TAG_URL="https://git.platypush.tech/platypush/platypush/archive/v$VERSION.tar.gz"
-
-    - echo "--- Preparing environment"
-    - 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
-    - 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
 
 ###
 ### Update the Debian (stable) packages
@@ -270,17 +171,15 @@ steps:
 
 - 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
-    S3_URL: s3://platypush-pkg/apt
-    AWS_ENDPOINT_URL: https://s3.nl-ams.scw.cloud
-    AWS_DEFAULT_REGION: nl-ams
-    AWS_ACCESS_KEY_ID:
-      from_secret: aws_access_key_id
-    AWS_SECRET_ACCESS_KEY:
-      from_secret: aws_secret_access_key
 
   when:
     branch:
@@ -289,74 +188,10 @@ steps:
       - push
 
   depends_on:
-    - build-ui
+    - update-components-cache
 
   commands:
-    - echo "-- Installing dependencies"
+    - . .drone/update-deb-packages.sh
-    - apt update
-    - apt install -y curl dpkg-dev gpg git python3 python3-pip
-    - pip install awscli --break-system-packages
-
-    - echo "-- Copying source directory"
-    - mkdir -p "$WORKDIR"
-    - export SRCDIR="$WORKDIR/src"
-    - cp -r "$PWD" "$SRCDIR"
-    - cd "$SRCDIR"
-
-    - 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) + 1))"
-    - export GIT_BUILD_DIR="$WORKDIR/$${PKG_NAME}_$${GIT_VERSION}_all"
-    - export GIT_DEB="$WORKDIR/$${PKG_NAME}_$${GIT_VERSION}_all.deb"
-
-    - 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
-
-    - 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
-    - dpkg --build "$GIT_BUILD_DIR"
-
-    - echo "--- Pushing package to the S3 bucket"
-    - aws s3 cp "$GIT_DEB" "$S3_URL/pool/$DEB_VERSION/dev/"
-
-    # If main/all/Packages doesn't exist, then we should create the first main release
-    - 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
-
-    # Don't proceed and update the main release if it hasn't changed
-    - |
-      if [ -z "$UPDATE_STABLE_PKG" ]; then
-        exit 0
-      fi
-
-    - echo "--- Updating main package"
-    - aws s3 cp "$GIT_DEB" "$S3_URL/pool/$DEB_VERSION/main/$${PKG_NAME}_$${VERSION}-1_all.deb"
 
 ###
 ### Update the Debian (oldstable) packages
@@ -364,17 +199,15 @@ steps:
 
 - 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
-    S3_URL: s3://platypush-pkg/apt
-    AWS_ENDPOINT_URL: https://s3.nl-ams.scw.cloud
-    AWS_DEFAULT_REGION: nl-ams
-    AWS_ACCESS_KEY_ID:
-      from_secret: aws_access_key_id
-    AWS_SECRET_ACCESS_KEY:
-      from_secret: aws_secret_access_key
 
   when:
     branch:
@@ -383,74 +216,38 @@ steps:
       - push
 
   depends_on:
-    - build-ui
+    - update-components-cache
 
   commands:
-    - echo "-- Copying source directory"
+    - . .drone/update-deb-packages.sh
-    - mkdir -p "$WORKDIR"
-    - export SRCDIR="$WORKDIR/src"
-    - cp -r "$PWD" "$SRCDIR"
-    - cd "$SRCDIR"
 
-    - echo "-- Installing dependencies"
+###
-    - apt update
+### Update the Ubuntu (latest) packages
-    - apt install -y curl dpkg-dev gpg git python3 python3-pip
+###
-    - pip install awscli
 
-    - echo "--- Parsing metadata"
+- name: update-ubuntu-packages
-    - git config --global --add safe.directory $PWD
+  image: ubuntu:latest
-    - git pull --rebase origin master --tags
+  volumes:
-    - export VERSION=$(python3 setup.py --version)
+    - name: repos
-    - export GIT_VERSION="$VERSION-$(( $(git log --pretty=oneline HEAD...v$VERSION | wc -l) + 1))"
+      path: /repos
-    - export GIT_BUILD_DIR="$WORKDIR/$${PKG_NAME}_$${GIT_VERSION}_all"
-    - export GIT_DEB="$WORKDIR/$${PKG_NAME}_$${GIT_VERSION}_all.deb"
 
-    - echo "--- Building git package"
+  environment:
-    - pip install --prefix="$GIT_BUILD_DIR/usr" --no-cache --no-deps .
+    DEB_VERSION: ubuntu
-    - |
+    WORKDIR: /tmp/workdir
-      find "$GIT_BUILD_DIR" -name "site-packages" | while read dir; do
+    APT_ROOT: /repos/apt
-        base="$(dirname "$dir")"
+    PKG_NAME: platypush
-        mv "$dir" "$base/dist-packages"
-      done
 
-    - mkdir -p "$GIT_BUILD_DIR/DEBIAN"
+  when:
-    - |
+    branch:
-      cat <<EOF > "$GIT_BUILD_DIR/DEBIAN/control"
+      - master
-      Package: $PKG_NAME
+    event:
-      Version: $GIT_VERSION
+      - push
-      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
-    - dpkg --build "$GIT_BUILD_DIR"
 
-    - echo "--- Pushing package to the S3 bucket"
+  depends_on:
-    - aws s3 cp "$GIT_DEB" "$S3_URL/pool/$DEB_VERSION/dev/"
+    - update-components-cache
 
-    # If main/all/Packages doesn't exist, then we should create the first main release
+  commands:
-    - export PKGURL="https://apt.platypush.tech/dists/$DEB_VERSION/main/all/Packages"
+    - . .drone/update-deb-packages.sh
-    - |
-      [ -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
-
-    # Don't proceed and update the main release if it hasn't changed
-    - |
-      if [ -z "$UPDATE_STABLE_PKG" ]; then
-        exit 0
-      fi
-
-    - echo "--- Updating main package"
-    - aws s3 cp "$GIT_DEB" "$S3_URL/pool/$DEB_VERSION/main/$${PKG_NAME}_$${VERSION}-1_all.deb"
 
 ###
 ### Updates the APT repository after new packages have been pushed
@@ -458,16 +255,13 @@ steps:
 
 - name: update-apt-repo
   image: debian:stable
-  privileged: true  # Required to use the FUSE module for s3fs
+  volumes:
+    - name: repos
+      path: /repos
+
   environment:
-    S3_BUCKET: platypush-pkg
+    REPOS_ROOT: /repos
-    BUCKET_MNT: /mnt/s3
+    APT_ROOT: /repos/apt
-    AWS_ENDPOINT_URL: https://s3.nl-ams.scw.cloud
-    AWS_DEFAULT_REGION: nl-ams
-    AWS_ACCESS_KEY_ID:
-      from_secret: aws_access_key_id
-    AWS_SECRET_ACCESS_KEY:
-      from_secret: aws_secret_access_key
     PGP_PUBKEY:
       from_secret: apt_pgp_pub_key
     PGP_PRIVKEY:
@@ -482,97 +276,10 @@ steps:
   depends_on:
     - update-debian-stable-packages
     - update-debian-oldstable-packages
+    - update-ubuntu-packages
 
   commands:
-    - echo "-- Installing dependencies"
+    - . .drone/update-apt-repo.sh
-    - apt update
-    - apt install -y s3fs dpkg-dev gpg
-
-    - echo "-- Mounting the S3 bucket"
-    - mkdir -p "$BUCKET_MNT"
-    - s3fs "$S3_BUCKET" "$BUCKET_MNT" -o url="$AWS_ENDPOINT_URL"
-    - export APT_ROOT="$BUCKET_MNT/apt"
-
-    - echo "-- Cleaning up older apt releases"
-    - |
-      find "$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="$APT_ROOT/pool/$distro/$branch"
-          [ -d "$branch_dir" ] || continue
-          dist_dir="$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: $APT_ROOT/|Filename: |"
-          cat "$pkg_file" | gzip -9 > "$pkg_file.gz"
-        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="$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 "-- Importing and refreshing PGP key"
-    - echo "$PGP_PUBKEY" > "$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 "$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
 
 ###
 ### Update the RPM (stable) packages
@@ -580,19 +287,16 @@ steps:
 
 - name: update-rpm-repo
   image: fedora
-  privileged: true  # Required to use the FUSE module for s3fs
+  volumes:
+    - name: repos
+      path: /repos
+
   environment:
     RPM_VERSION: stable
+    REPOS_ROOT: /repos
+    RPM_ROOT: /repos/rpm
     WORKDIR: /tmp/workdir
     PKG_NAME: platypush
-    S3_BUCKET: platypush-pkg
-    BUCKET_MNT: /mnt/s3
-    AWS_ENDPOINT_URL: https://s3.nl-ams.scw.cloud
-    AWS_DEFAULT_REGION: nl-ams
-    AWS_ACCESS_KEY_ID:
-      from_secret: aws_access_key_id
-    AWS_SECRET_ACCESS_KEY:
-      from_secret: aws_secret_access_key
     PGP_PUBKEY:
       from_secret: rpm_pgp_pub_key
     PGP_PRIVKEY:
@@ -605,179 +309,17 @@ steps:
       - push
 
   depends_on:
-    - build-ui
+    - update-components-cache
 
   commands:
-    - echo "-- Installing dependencies"
+    - . .drone/update-rpm-repo.sh
-    - yum install -y createrepo rpm-build rpm-sign gpg wget yum-utils git python python-pip s3fs-fuse
-
-    - echo "-- Copying source directory"
-    - mkdir -p "$WORKDIR"
-    - export SRCDIR="$WORKDIR/src"
-    - cp -r "$PWD" "$SRCDIR"
-    - cd "$SRCDIR"
-
-    - echo "-- Mounting the S3 bucket"
-    - mkdir -p "$BUCKET_MNT"
-    - s3fs "$S3_BUCKET" "$BUCKET_MNT" -o url="$AWS_ENDPOINT_URL"
-    - export RPM_ROOT="$BUCKET_MNT/rpm"
-    - 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
-
-      %description
-      Universal command executor and automation hub.
-
-      %install
-      mkdir -p %{buildroot}/
-      cp -r "$BUILD_DIR"/* %{buildroot}/
-
-      %clean
-
-      %files
-      /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
-
-      %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 .
-    - 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
-
-      %description
-      Universal command executor and automation hub.
-
-      %install
-      mkdir -p %{buildroot}/
-      cp -r "$BUILD_DIR"/* %{buildroot}/
-
-      %clean
-
-      %files
-      /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
-
-      %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"
-
-    - echo "--- Updating the S3 bucket"
-    - export NEW_RPM_ROOT="$BUCKET_MNT/rpm_new"
-    - export OLD_RPM_ROOT="$BUCKET_MNT/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"
 
 ###
 ### Updates the pip package upon new releases
 ###
 
 - name: update-pip-package
-  image: python:3.11-alpine
+  image: alpine
   environment:
     TWINE_USERNAME:
       from_secret: pypi_user
@@ -793,9 +335,32 @@ steps:
     - docs
 
   commands:
-    - apk add --update --no-cache py3-twine
+    - . .drone/update-pip-package.sh
-    - python setup.py sdist bdist_wheel
+
-    - twine upload dist/platypush-$(python setup.py --version).tar.gz
+###
+### Update the Docker image
+###
+
+- name: update-image-registry
+  image: docker
+  privileged: true
+  volumes:
+    - name: docker_sock
+      path: /var/run/docker.sock
+
+  environment:
+    REGISTRY_ENDPOINT: quay.io
+    DOCKER_HOST: "unix:///var/run/docker.sock"
+    DOCKER_USER: platypush
+    DOCKER_PASS:
+      from_secret: registry_token
+
+  commands:
+    - . .drone/update-image-registry.sh
+
+  when:
+    event:
+      - tag
 
 ###
 ### Checkpoint step that waits for all the package update
@@ -812,9 +377,10 @@ steps:
       - push
 
   depends_on:
-    - update-arch-packages
+    # - update-arch-git-package
     - update-rpm-repo
     - update-apt-repo
+    - update-image-registry
 
   commands:
     - echo "All packages have been successfully updated"
@@ -835,6 +401,7 @@ steps:
 
   depends_on:
     - update-pip-package
+    - update-arch-stable-package
 
   commands:
     - apk add --update --no-cache curl

.drone/build-ui.sh

@@ -0,0 +1,46 @@
+#!/bin/sh
+
+export SRCDIR="$PWD"
+export WEBAPP_DIR="$SRCDIR/platypush/backend/http/webapp"
+export SKIPCI="$PWD/.skipci"
+rm -rf "$SKIPCI"
+
+. .drone/macros/configure-git.sh
+
+cd "$WEBAPP_DIR"
+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"
+cd "$SRCDIR"
+
+. .drone/macros/configure-ssh.sh
+. .drone/macros/configure-gpg.sh
+
+git add "${WEBAPP_DIR}/dist"
+git commit "${WEBAPP_DIR}/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,23 @@
+#!/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
+branch=$(git rev-parse --abbrev-ref HEAD)
+if [ -z "${branch}" ]; then
+  echo "No branch checked out"
+  exit 1
+fi
+
+git remote add github git@github.com:/blacklight/platypush.git
+
+if [[ "$branch" == "master" ]]; then
+  git pull --rebase github "${branch}" || echo "No such branch on Github"
+fi
+
+# Push the changes to the GitHub mirror
+git push -f --all -v github
+git push --tags -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,27 @@
+#!/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
+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/update-apt-repo.sh

@@ -0,0 +1,169 @@
+#!/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\nubuntu" | 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\nubuntu" | 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 ubuntu; 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
+====================================================
+
+# wget -q -O \\\
+    /etc/apt/trusted.gpg.d/platypush.asc \\\
+    https://apt.platypush.tech/pubkey.txt
+
+2. Add the repository to your sources
+=====================================
+
+# 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:
+  - *stable* - current Debian stable version
+  - *oldstable* - previous Debian stable version
+  - *ubuntu* - latest Ubuntu version
+
+- branch can be either:
+  - *main* - latest stable release
+  - *dev* a package always in sync with the git version
+
+For example, to install the latest stable tags on Debian stable:
+
+# wget -q -O \\\
+    /etc/apt/sources.list.d/platypush.list \\\
+    https://apt.platypush.tech/lists/platypush-stable-main.list
+
+3. Update your repos
+====================
+
+# apt update
+
+4. Install Platypush
+====================
+
+# 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-git-package.sh

@@ -0,0 +1,38 @@
+#!/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}"
+
+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

.drone/update-arch-stable-package.sh

@@ -0,0 +1,46 @@
+#!/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 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 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
+  echo "--- No changes in the stable package version"
+  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,103 @@
+#!/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"
+export DEBIAN_FRONTEND=noninteractive
+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=$(grep -e '^__version__' "${SRCDIR}/version.py" | sed -r -e 's/^__version__\s*=\s*"([^"]+)"$/\1/')
+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-image-registry.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+[ -z "$DOCKER_USER" ] && echo "Please set the DOCKER_USER environment variable" && exit 1
+[ -z "$DOCKER_PASS" ] && echo "Please set the DOCKER_PASS environment variable" && exit 1
+
+export VERSION=$(grep current_version pyproject.toml | sed -r -e "s/.*=\s*['\"]?([^'\"]+)['\"]?\s*$/\1/")
+export REGISTRY_ENDPOINT="${REGISTRY_ENDPOINT:-quay.io}"
+export IMAGE_NAME="$REGISTRY_ENDPOINT/$DOCKER_USER/platypush"
+
+# Log in to the registry
+docker login "$REGISTRY_ENDPOINT" -u "$DOCKER_USER" -p "$DOCKER_PASS"
+
+# Required for multi-platform builds
+docker buildx create --name=multiarch --driver=docker-container
+
+# Build and publish the images
+docker buildx build \
+  -f Dockerfile.alpine \
+  -t "$IMAGE_NAME:$VERSION" \
+  -t "$IMAGE_NAME:latest" \
+  --platform linux/amd64,linux/arm64,linux/arm/v7 \
+  --builder multiarch \
+  --push .
+
+# Clean up
+docker buildx rm multiarch

.drone/update-pip-package.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+apk add --update --no-cache py3-twine py3-setuptools py3-wheel py3-pip
+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=$(grep -e '^__version__' "${SRCDIR}/version.py" | sed -r -e 's/^__version__\s*=\s*"([^"]+)"$/\1/')
+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
+=====================================
+
+# yum config-manager --add-repo https://rpm.platypush.tech/platypush.repo
+
+2. Install Platypush
+====================
+
+# yum install platypush
+
+Or, if you want to install a version always up-to-date with the git repo:
+
+# 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"

.env.example

@@ -0,0 +1,22 @@
+# The device ID is the unique identifier for the device that runs Platypush.
+# You should make sure that it's unique at least within your local network,
+# as it is used to identify the device in the MQTT topics, on the HTTP API
+# and on the published ZeroConf services.
+PLATYPUSH_DEVICE_ID=platypush
+
+# Use an external Redis server for the message queue. By default, the Platypush
+# container will run a Redis server on the same container. Also remove the
+# `--start-redis` option from the `docker run` command if you want to use an
+# external Redis server.
+# PLATYPUSH_REDIS_HOST=localhost
+# PLATYPUSH_REDIS_PORT=6379
+
+# Custom location for the Platypush configuration file.
+# PLATYPUSH_CONFIG=/etc/platypush/config.yaml
+
+# Custom location for the Platypush working directory.
+# PLATYPUSH_WORKDIR=/var/lib/platypush
+
+# SQLAlchemy database URL. By default, the Platypush container will run on a
+# SQLite database installed under <WORKDIR>/main.db. If you want
+# PLATYPUSH_DB=sqlite:////var/lib/platypush/main.db

.gitignore

@@ -25,3 +25,7 @@ Session.vim
 /jsconfig.json
 /package.json
 /Dockerfile
+/docs/source/wiki
+/.skipci
+dump.rdb
+.env

.ignore

@@ -0,0 +1 @@
+dist/

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.6.0
     hooks:
     # -   id: trailing-whitespace
     # -   id: end-of-file-fixer
@@ -11,15 +11,15 @@ repos:
     - id: check-xml
     - id: check-symlinks
     - id: check-added-large-files
-      args: ['--maxkb=1500']
+      args: ['--maxkb=3000']
 
 -   repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
     rev: v1.1.2
     hooks:
     -   id: markdown-toc
 
-- repo: https://github.com/pycqa/flake8
+- repo: https://github.com/PyCQA/flake8
-  rev: 4.0.1
+  rev: 7.1.0
   hooks:
     - id: flake8
       additional_dependencies:

CHANGELOG.md

@@ -1,8 +1,422 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## [1.3.6]
-Given the high speed of development in the first phase, changes are being
+
-reported only starting from v0.20.2.
+- [[#445](https://git.platypush.tech/platypush/platypush/issues/445)]: fixed
+  schemas compatibility with Marshmallow >= 4.0.0.
+
+- [[#444](https://git.platypush.tech/platypush/platypush/issues/444)]: fixed
+  expiration of session cookies.
+
+- [`youtube`], [[`5ca39d08`](https://git.platypush.tech/platypush/platypush/commit/5ca39d086aeb93c3e262791535c82aec1d4ba033)]:
+  fixed support for YouTube URL on media plugins UI when using a proxy instance
+  such as Invidious or Piped.
+
+- [`media.mpv`], [[`06746c70`](https://git.platypush.tech/platypush/platypush/commit/06746c7032bd453862db81cdcec6f3c6330a9d7e)]:
+  enabled verbose logging of MPV player events when Platypush is launched in
+  `debug`/`-v` mode.
+
+- [`foursquare`], [[`a13b5e0c`](https://git.platypush.tech/platypush/platypush/commit/a13b5e0cb7c2a4ad6492a2d31fce18f3c5877a2f)]:
+  fixed `limit` and `offset` parameters for the `foursquare.get_checkins` action.
+
+- [`foursquare`], [[`ab64424a`](https://git.platypush.tech/platypush/platypush/commit/a13b5e0cb7c2a4ad6492a2d31fce18f3c5877a2f)]:
+  fixed polling logic.
+
+- Upgraded frontend dependencies.
+
+## [1.3.5]
+
+- [[#440](https://git.platypush.tech/platypush/platypush/issues/440)]: the
+  `youtube` plugin now supports multiple backends:
+
+  - `piped` (originally supported)
+  - `invidious` (new integration, and recommended over `piped`)
+  - `google` (implementation that leverages the native YouTube Data API)
+
+- [[#437](https://git.platypush.tech/platypush/platypush/issues/437)]: added a
+  new _Application_ panel to the UI, which includes real-time monitors for
+  events and executed commands.
+
+- [`music.mopidy`]: many performance improvements and better handling of failures.
+
+- [`14f97904`]((https://git.platypush.tech/platypush/platypush/commit/14f979049bd97ff96f37a9f2a50d0193ae784aa8):
+  fixed handling of ungrouped lights on the `light.hue` UI.
+
+- [`f7125376`](https://git.platypush.tech/platypush/platypush/commit/f7125376730f8b890e6681d8302e2fc2740cf26e):
+  replaced `kafka` dependency for the `kafka` plugin with `kafka-python-ng`,
+  given the low maintenance status of the Kafka package. This also adds the
+  following features to the Kafka plugin:
+
+  - Added partition, key, offset, timestamp and headers to
+    `KafkaMessageEvent`.
+
+  - Added `group_id` to consumers configuration.
+
+  - Added `key`, `timeout` and `compression_type` to `kafka.publish`.
+
+- [`acaca67c`](https://git.platypush.tech/platypush/platypush/commit/acaca67c615dff3cb2ca527e8533a2cd32d19ef8):
+  fixed a resource leak on the Websocket interface when authentication fails.
+
+- [`61b2afce`](https://git.platypush.tech/platypush/platypush/commit/61b2afce91b3b376b8aa028360c87aeef54e2be3):
+  removed deprecated `ssl.wrap_socket()` calls from SSL initialization logic (it's been removed in Python 3.12).
+  This also fixes the `irc` integration on newer versions of Python.
+
+- [`575c0ab7`](https://git.platypush.tech/platypush/platypush/commit/61b2afce91b3b376b8aa028360c87aeef54e2be3):
+  improved file editor UI.
+
+## [1.3.4]
+
+- [Bug]: Fixed installation bug in `pip install platypush` introduced by the
+  `pyproject.toml` migration.
+
+## [1.3.3]
+
+- [`3e02304a`](https://git.platypush.tech/platypush/platypush/commit/3e02304ac203625650ab4b03f9d4146a40839f2f)
+  [Auth]: Fixed generation of API tokens when 2FA is enabled.
+
+## [1.3.2]
+
+- [[#414](https://git.platypush.tech/platypush/platypush/issues/414)]: added
+  Jellyfin UI for all media plugins. This makes it possible to browse and play
+  media items from the Jellyfin library on multiple devices.
+
+- [[#434](https://git.platypush.tech/platypush/platypush/issues/434)]: added
+  official Docker base image - [see
+  documentation](https://docs.platypush.tech/wiki/Installation.html#docker).
+
+- [_Other Docker improvements_]
+  * Reduced size for the base images.
+  * Better self-documented [`docker-compose.yml`
+    file](https://git.platypush.tech/platypush/platypush/src/branch/master/docker-compose.yml).
+
+- [[`db`](https://git.platypush.tech/platypush/platypush/commit/dd02be12)]:
+  Fixed compatibility of transaction scopes with SQLAlchemy 2.0.
+
+- [`media.vlc`]: Improved state management.
+
+- [`media.mpv`]: Enhanced compatibility. mpv 1.0 introduced many breaking
+  changes in the event management API, but it may not yet be available on all
+  distros. Platypush has now introduced a compatibility layer to seamlessly
+  interact with any version of mpv.
+
+- [_Media UI_] Added support for embedded players for Jellyfin, YouTube and
+  local media.
+
+- [[`http.webpage`](https://git.platypush.tech/platypush/platypush/commit/09413bc0)]:
+  Added support for custom headers to the scraping functions.
+
+## [1.3.1]
+
+- [[#344](https://git.platypush.tech/platypush/platypush/issues/344)]: removed
+  `marshmallow_dataclass` dependency. That package isn't included in the
+  package managers of any supported distros and requires to be installed via
+  pip. Making the Platypush' system packages depend on a pip-only package is
+  not a good idea. Plus, the library seems to be still in heavy development and
+  it has already broken compatibility with at least the `system` package.
+
+## [1.3.0]
+
+- [[#333](https://git.platypush.tech/platypush/platypush/issues/333)]: new file
+  browser UI/component. It includes custom MIME type support, a file editor
+  with syntax highlight, file download and file upload.
+
+- [[#341](https://git.platypush.tech/platypush/platypush/issues/341)]:
+  procedures are now native entities that can be managed from the entities panel.
+  A new versatile procedure editor has also been added, with support for nested
+  blocks, conditions, loops, variables, context autocomplete, and more.
+
+- [`procedure`]: Added the following features to YAML/structured procedures:
+
+  - `set`: to set variables whose scope is limited to the procedure / code
+    block where they are created. `variable.set` is useful to permanently
+    store variables on the db, `variable.mset` is useful to set temporary
+    global variables in memory through Redis, but sometimes you may just want
+    to assign a value to a variable that only needs to live within a procedure,
+    event hook or cron.
+
+    ```yaml
+    - set:
+        foo: bar
+        temperature: ${output.get('temperature')}
+    ```
+
+  - `return` can now return values too when invoked within a procedure:
+
+      ```yaml
+      - return: something
+      # Or
+      - return: "Result: ${output.get('response')}"
+      ```
+
+- The default logging format is now much more compact. The full body of events
+  and requests is no longer included by default in `info` mode - instead, a
+  summary with the message type, ID and response time is logged. The full
+  payloads can still be logged by enabling `debug` logs through e.g. `-v`.
+
+## [1.2.3]
+
+- [[#422](https://git.platypush.tech/platypush/platypush/issues/422)]: adapted
+  media plugins to support streaming from the yt-dlp process. This allows
+  videos to have merged audio+video even if they had separate tracks upstream.
+
+- [`media.*`] Many improvements on the media UI.
+
+- [`zigbee.mqtt`] Removed synchronous logic from `zigbee.mqtt.device_set`. It
+  was prone to timeouts as well as pointless - the updated device state will
+  anyway be received as an event.
+
+## [1.2.2]
+
+- Fixed regression on older version of Python that don't fully support
+  `pyproject.toml` and can't install data files the new way.
+
+## [1.2.1]
+
+- Added static `/login` and `/register` Flask fallback routes to prevent 404 if
+  the client doesn't have JavaScript enabled.
+
+- Fixed `apt` packages for Debian oldstable after the `setup.py` to
+  `pyproject.toml` migration.
+
+- Fixed license string in the `pyproject.toml`.
+
+## [1.2.0]
+
+- [#419](https://git.platypush.tech/platypush/platypush/issues/419): added
+  support for randomly generated API tokens alongside JWT.
+
+- [#339](https://git.platypush.tech/platypush/platypush/issues/339): added
+  support for 2FA with OTP codes.
+
+- [#393](https://git.platypush.tech/platypush/platypush/issues/393): added
+  `bind_socket` parameter to `backend.http`, so Platypush can listen on (or
+  exclusively if `listen_port` is null) on a local UNIX socket as well.
+
+- [#401](https://git.platypush.tech/platypush/platypush/issues/401): added
+  `--redis-bin` option / `PLATYPUSH_REDIS_BIN` environment variable to support
+  custom Redis (or drop-in replacements) executables when `--start-redis` is
+  specified.
+
+- [#413](https://git.platypush.tech/platypush/platypush/issues/401): added
+  support for page-specific PWAs. If you navigate to `/plugin/<plugin-name>`,
+  and you install it as a PWA, you'll install a PWA only for that plugin - not
+  for the whole Platypush UI.
+
+- Migrated project setup from `setup.py` to `pyproject.toml`.
+
+- [`70db33b4e`](https://git.platypush.tech/platypush/platypush/commit/70db33b4e):
+  more application resilience in case Redis goes down.
+
+- [`ee27b2c4`](https://git.platypush.tech/platypush/platypush/commit/ee27b2c4):
+  Refactor of all the authentication endpoints into a single `/auth` endpoint:
+
+  - `POST /register` → `POST /auth?type=register`
+  - `POST /login` → `POST /auth?type=login`
+  - `POST /auth` → `POST /auth?type=token`
+  - `POST /auth` → `POST /auth?type=jwt`
+
+- [`2ccf0050`](https://git.platypush.tech/platypush/platypush/commit/2ccf0050):
+  Added support for binary content to `qrcode.generate`.
+
+- [`b69e9500`](https://git.platypush.tech/platypush/platypush/commit/b69e9500):
+  Support for fullscreen mode on the `camera` plugins UI.
+
+## [1.1.3] - 2024-07-16
+
+- [`core`]: New architecture for the Redis bus - now leveraging pub/sub with a
+  connection pool instead of a single-connection queue. It makes the
+  application much faster and less prone to Redis deadlocks.
+
+- [`youtube`]:
+  [#391](https://git.platypush.tech/platypush/platypush/issues/391): added
+  support for:
+
+  - Add/remove playlists (UI)
+  - Add to/remove from playlist (UI)
+  - Subscribe/unsubscribe from channels (UI)
+  - Browse channels and playlists directly in the UI
+  - Download media and audio
+
+## [1.1.1] - 2024-06-24
+
+- [`torrent`]: [[#263](https://git.platypush.tech/platypush/platypush/issues/263)], [[#375](https://git.platypush.tech/platypush/platypush/issues/375)],
+  [[#407](https://git.platypush.tech/platypush/platypush/issues/407)] and
+  [[#408](https://git.platypush.tech/platypush/platypush/issues/408)]: added
+  torrents.csv search provider and rewritten torrents UI.
+
+- [[#281](https://git.platypush.tech/platypush/platypush/issues/281)]
+  replaced `warnings.warn` with `logging.warning`, as there is no easy and
+  reliable way of routing `warnings.warn` to `logging`.
+
+## [1.1.0] - 2024-06-06
+
+- [[#405](https://git.platypush.tech/platypush/platypush/issues/405)] Fixed
+  timezone/timestamp rendering issues for `calendar.ical` events.
+- [[#403](https://git.platypush.tech/platypush/platypush/issues/403)]
+  Included inherited actions in plugins docs.
+
+## [1.0.7] - 2024-06-02
+
+- [[#384](https://git.platypush.tech/platypush/platypush/issues/384)] Added
+  `assistant.openai` and `tts.openai` plugins.
+
+## [1.0.6] - 2024-06-01
+
+- 🐛 Bug fix on one of the entities modules that prevented the application from
+  loading when `.` is part of `PYTHONPATH`.
+
+## [1.0.5] - 2024-06-01
+
+- A proper solution for the `utcnow()` issue.
+
+It was a bit trickier than expected to solve, but now Platypush uses a
+`utcnow()` facade that always returns a UTC datetime in a timezone-aware
+representation.
+
+The code should however also handle the case of timestamps stored on the db in
+the old format.
+
+## [1.0.4] - 2024-05-31
+
+- Fixed regression introduced by
+  [c18768e61fef62924f4c1fac3089ecfb83666dab](https://git.platypush.tech/platypush/platypush/commit/c18768e61fef62924f4c1fac3089ecfb83666dab).
+  Python seems to have introduced a breaking change from the version 3.12 -
+  `datetime.utcnow()` is not deprecated, but `datetime.UTC`, the suggested
+  alternative, isn't available on older versions of Python. Added a workaround
+  that makes Platypush compatible with both the implementations.
+
+## [1.0.3] - 2024-05-31
+
+- [[#368](https://git.platypush.tech/platypush/platypush/issues/368)] Added
+  Ubuntu packages.
+
+- Fixed bug that didn't get hooks to match events imported through the new
+  `platypush.events` symlinked module.
+
+## [1.0.2] - 2024-05-26
+
+- Fixed regression introduced by the support of custom names through the
+  `@procedure` decorator.
+
+## [1.0.0] - 2024-05-26
+
+Many, many changes for the first major release of Platypush after so many
+years.
+
+- [!3](https://git.platypush.tech/platypush/platypush/milestone/3) All
+  backends, except for `http`, `nodered`, `redis` and `tcp`, are gone. Many
+  were already deprecated a while ago, but the change now applies to all of
+  them. Backends should only be components that actively listen for application
+  messages to process, not generic daemon threads for integrations. This had
+  been a source of confusion for a long time. Backends and plugins are now
+  merged, meaning that you won't need to configure two different sections
+  instead of one for many integrations (one for the stateless plugin, and one
+  for the background state listener). Please check the
+  [documentation](https://docs.platypush.tech) to verify the configuration
+  changes required by your integrations. This has been a long process that has
+  involved the rewrite of most of the integrations, and many bugs have been
+  fixed.
+
+- Improved Docker support - now with a default `docker-compose.yml`, multiple
+  Dockerfiles for
+  [Alpine](https://git.platypush.tech/platypush/platypush/src/branch/master/platypush/install/docker/alpine.Dockerfile),
+  [Debian](https://git.platypush.tech/platypush/platypush/src/branch/master/platypush/install/docker/debian.Dockerfile),
+  [Ubuntu](https://git.platypush.tech/platypush/platypush/src/branch/master/platypush/install/docker/ubuntu.Dockerfile)
+  and
+  [Fedora](https://git.platypush.tech/platypush/platypush/src/branch/master/platypush/install/docker/fedora.Dockerfile)
+  base images. Many improvements on the `platydock` and `platyvenv` scripts
+  too, with better automated installation processes for optional dependencies.
+
+- Added [official
+  packages](https://git.platypush.tech/platypush/platypush#system-package-manager-installation)
+  for
+  [Debian](https://git.platypush.tech/platypush/platypush#debian-ubuntu)
+  and [Fedora](https://git.platypush.tech/platypush/platypush#fedora).
+
+- Added `--device-id`, `--workdir`, `--logsdir`, `--cachedir`, `--main-db`,
+  `--redis-host`, `--redis-port` and `--redis-queue` CLI arguments, along the
+  `PLATYPUSH_DEVICE_ID`, `PLATYPUSH_WORKDIR`, `PLATYPUSH_LOGSDIR`,
+  `PLATYPUSH_CACHEDIR`, `PLATYPUSH_DB`, `PLATYPUSH_REDIS_HOST`,
+  `PLATYPUSH_REDIS_PORT` and `PLATYPUSH_REDIS_QUEUE` environment variables.
+
+- Added an _Extensions_ panel to the UI to dynamically:
+    - Install new dependencies directly from the Web view.
+    - Explore the documentation as well as the supported actions and events for
+      each plugin.
+    - Get ready-to-paste configuration snippets/templates.
+
+- New, completely rewritten [documentation](https://docs.platypush.tech), which
+  now integrates the wiki, dynamically includes plugins configuration snippets
+  and dependencies, and adds a global filter bar for the integrations.
+
+- [[#394](https://git.platypush.tech/platypush/platypush/issues/394)] A more
+  intuitive way of installing extra dependencies via `pip`. Instead of a static
+  list that the user should check inside of `setup.py`, the syntax `pip install
+  'platypush[plugin1,plugin2,...]'` is now supported.
+
+- No more need to manually create `__init__.py` in each of the `scripts`
+  folders that you want to use to store your custom scripts. Automatic
+  discovery of scripts and creation of module files has been implemented. You
+  can now just drop a `.py` script with your procedures, hooks or crons in the
+  scripts folder and it should be picked up by the application.
+
+- The _Execute_ Web panel now supports procedures too, as well as curl snippets.
+
+- Removed all `Response` objects outside of the root type. They are now all
+  replaced by Marshmallow schemas with the structure automatically generated in
+  the documentation.
+
+- [`alarm`] [[#340](https://git.platypush.tech/platypush/platypush/issues/340)]
+  Rewritten integration. It now includes a powerful UI panel to set up alarms
+  with custom procedures too.
+
+- [`assistant.picovoice`]
+  [[#304](https://git.platypush.tech/platypush/platypush/issues/304)] New
+  all-in-one Picovoice integration that replaces the previous `stt.picovoice.*`
+  integrations.
+
+- [`youtube`]
+  [[#337](https://git.platypush.tech/platypush/platypush/issues/337)] Full
+  rewrite of the plugin. It now supports Piped instances instead of the
+  official YouTube API. A new UI has also been designed to explore
+  subscriptions, playlists and channels.
+
+- [`weather.*`]
+  [[#308](https://git.platypush.tech/platypush/platypush/issues/308)] Removed
+  the `weather.darksky` integration (it's now owned by Apple and the API is
+  basically dead) and enhanced the `weather.openweathermap` plugin instead.
+
+- [`camera.pi*`] The old `camera.pi` integration based on the deprecated
+  `picamera` module has been moved to `camera.pi.legacy`. `camera.pi` is now a
+  new plugin which uses the new `picamera2` API (and it's so far only
+  compatible with recent versions on the Raspberry Pi OS).
+
+- Dynamically auto-generate plugins documentation in the UI from the RST
+  docstrings.
+
+- New design for the configuration panel.
+
+- Better synchronization between processes on threads on application stop -
+  greatly reduced the risk of hanging processes on shutdown.
+
+- Migrated all CI/CD pipelines to [Drone
+  CI](https://ci-cd.platypush.tech/platypush/platypush).
+
+- Removed `google.fit` integration, as Google has deprecated the API.
+
+- Removed `wiimote` integration: the `cwiid` library hasn't been updated in
+  years, it doesn't even work well with Python 3, and I'm not in the mood of
+  bringing it back from the dead.
+
+- Removed `stt.deepspeech` integration. That project has been basically
+  abandoned by Mozilla, the libraries are very buggy and I don't think it's
+  going to see new developments any time soon.
+
+- [[#297](https://git.platypush.tech/platypush/platypush/issues/297)] Removed
+  `spotify` backend integration based on Librespot. The project has gone
+  through a lot of changes, and I no longer have a Spotify premium account to
+  work on a new implementation. Open to contributions if somebody still wants
+  it.
 
 ## [0.50.3] - 2023-07-22
 

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:
+- If the feature requires an optional dependency then make sure to document it
-
+  in the `manifest.json` - refer to the Wiki (how to write
-  - In the class docstring (see other plugins and backends for examples).
+  [plugins](https://git.platypush.tech/platypush/platypush/wiki/Writing-your-own-plugins)
-  - In [`setup.py`](https://git.platypush.tech/platypush/platypush/-/blob/master/setup.py#L72) as
+  and
-    an `extras_require` entry.
+  [backends](https://git.platypush.tech/platypush/platypush/wiki/Writing-your-own-backends))
-  - In the plugin/backend class pydoc string.
+  for examples on how to write an extension manifest file.
-  - 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.

Dockerfile.alpine

@@ -0,0 +1 @@
+platypush/install/docker/alpine.Dockerfile

LICENSE.txt

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

MANIFEST.in

@@ -2,4 +2,16 @@ 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
+
+global-exclude __pycache__/*
+global-exclude *.pyc
+
+# Exclude symlinks to avoid issues with setuptools
+exclude platypush/backend/http/webapp/public/icons/openweathermap/black
+exclude platypush/backend/http/webapp/public/icons/openweathermap/white
+exclude platypush/backend/http/webapp/src/**
+exclude platypush/events
+exclude platypush/install/scripts/ubuntu

docker-compose.yml

@@ -0,0 +1,61 @@
+services:
+  platypush:
+    # Replace the build section with the next line if instead of building the
+    # image from a local checkout you want to pull the latest base
+    # (Alpine-based) image from the remote registry
+    # image: "quay.io/platypush/platypush:latest"
+
+    build:
+      context: .
+      # Alpine base image
+      dockerfile: ./platypush/install/docker/alpine.Dockerfile
+      # Debian base image
+      # dockerfile: ./platypush/install/docker/debian.Dockerfile
+      # Ubuntu base image
+      # dockerfile: ./platypush/install/docker/ubuntu.Dockerfile
+      # Fedora base image
+      # dockerfile: ./platypush/install/docker/fedora.Dockerfile
+
+    restart: "always"
+    command:
+      - platypush
+      - --redis-host
+      - redis
+      # Or, if you want to run Redis from the same container as Platypush,
+      # replace --redis-host redis with the line below
+      # - --start-redis
+
+    # Custom list of host devices that should be accessible to the container -
+    # e.g. an Arduino, an ESP-compatible microcontroller, a joystick etc.
+    # devices:
+    #   - /dev/ttyUSB0
+
+    # Uncomment if you need plugins that require access to low-level hardware
+    # (e.g. Bluetooth BLE or GPIO/SPI/I2C) if access to individual devices is
+    # not enough or isn't practical
+    # privileged: true
+
+    # Copy .env.example to .env and modify as needed
+    # env_file:
+    #   - .env
+
+    ports:
+      # Comment if you don't have the HTTP backend enable or you don't want to
+      # expose it
+      - "8008:8008"
+
+    # volumes:
+      # Replace with a path that contains/will contain your config.yaml file
+      # - /path/to/your/config:/etc/platypush
+      # Replace with a path that contains/will contain your working directory
+      # - /path/to/a/workdir:/var/lib/platypush
+      # Optionally, use an external volume for the cache
+      # - /path/to/a/cachedir:/var/cache/platypush
+      # This may be required, together with privileged mode, if you want the
+      #   container to access the USB bus on the host (required for example if
+      #   you have USB audio devices that you want to access from your plugins,
+      #   or Bluetooth dongles, or other USB adapters).
+      # - /dev/bus/usb:/dev/bus/usb
+
+  redis:
+    image: redis

docs/source/_ext/add_dependencies.py

@@ -3,7 +3,6 @@ import os
 import re
 import sys
 import textwrap as tw
-from contextlib import contextmanager
 
 from sphinx.application import Sphinx
 
@@ -13,14 +12,14 @@ base_path = os.path.abspath(
 
 sys.path.insert(0, base_path)
 
-from platypush.utils import get_plugin_name_by_class  # noqa
+from platypush.common.reflection import Integration  # noqa: E402
-from platypush.utils.mock import mock  # noqa
+from platypush.utils import get_plugin_name_by_class  # noqa: E402
-from platypush.utils.reflection import IntegrationMetadata, import_file  # noqa
+from platypush.utils.mock import auto_mocks  # noqa: E402
 
 
 class IntegrationEnricher:
     @staticmethod
-    def add_events(source: list[str], manifest: IntegrationMetadata, idx: int) -> int:
+    def add_events(source: list[str], manifest: Integration, idx: int) -> int:
         if not manifest.events:
             return idx
 
@@ -37,7 +36,7 @@ class IntegrationEnricher:
         return idx + 1
 
     @staticmethod
-    def add_actions(source: list[str], manifest: IntegrationMetadata, idx: int) -> int:
+    def add_actions(source: list[str], manifest: Integration, idx: int) -> int:
         if not (manifest.actions and manifest.cls):
             return idx
 
@@ -56,11 +55,16 @@ class IntegrationEnricher:
 
     @staticmethod
     def _shellify(title: str, cmd: str) -> str:
-        return f'**{title}**\n\n' + '.. code-block:: bash\n\n\t' + cmd + '\n\n'
+        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: IntegrationMetadata, idx: int
+        cls, source: list[str], manifest: Integration, idx: int
     ) -> int:
         deps = manifest.deps
         parsed_deps = {
@@ -80,7 +84,9 @@ class IntegrationEnricher:
             idx += 1
 
         if parsed_deps['pip']:
-            source.insert(idx, cls._shellify('pip', 'pip ' + ' '.join(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():
@@ -104,9 +110,7 @@ class IntegrationEnricher:
         return idx
 
     @classmethod
-    def add_description(
+    def add_description(cls, source: list[str], manifest: Integration, idx: int) -> int:
-        cls, source: list[str], manifest: IntegrationMetadata, idx: int
-    ) -> int:
         docs = (
             doc
             for doc in (
@@ -125,7 +129,7 @@ class IntegrationEnricher:
 
     @classmethod
     def add_conf_snippet(
-        cls, source: list[str], manifest: IntegrationMetadata, idx: int
+        cls, source: list[str], manifest: Integration, idx: int
     ) -> int:
         source.insert(
             idx,
@@ -155,14 +159,14 @@ class IntegrationEnricher:
             base_path,
             *doc.split(os.sep)[:-1],
             *doc.split(os.sep)[-1].split('.'),
-            'manifest.yaml',
+            'manifest.json',
         )
 
         if not os.path.isfile(manifest_file):
             return
 
-        with mock_imports():
+        with auto_mocks():
-            manifest = IntegrationMetadata.from_manifest(manifest_file)
+            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)
@@ -173,14 +177,6 @@ class IntegrationEnricher:
         source[0] = '\n'.join(src)
 
 
-@contextmanager
-def mock_imports():
-    conf_mod = import_file(os.path.join(base_path, 'docs', 'source', 'conf.py'))
-    mock_mods = getattr(conf_mod, 'autodoc_mock_imports', [])
-    with mock(*mock_mods):
-        yield
-
-
 def setup(app: Sphinx):
     app.connect('source-read', IntegrationEnricher())
     return {

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 === '/' || 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,188 @@
+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,
+ul.grid li:hover a > code {
+  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,47 +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/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/joystick.rst
-    platypush/backend/joystick.jstest.rst
-    platypush/backend/joystick.linux.rst
-    platypush/backend/kafka.rst
-    platypush/backend/log.http.rst
-    platypush/backend/mail.rst
-    platypush/backend/midi.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/trello.rst
-    platypush/backend/weather.buienradar.rst
-    platypush/backend/weather.darksky.rst
-    platypush/backend/weather.openweathermap.rst
-    platypush/backend/wiimote.rst

docs/source/conf.py

@@ -21,7 +21,7 @@ sys.path.insert(0, os.path.abspath("./_ext"))
 # -- Project information -----------------------------------------------------
 
 project = 'Platypush'
-copyright = '2017-2023, Fabio Manganiello'
+copyright = '2017-2024, Fabio Manganiello'
 author = 'Fabio Manganiello <fabio@manganiello.tech>'
 
 # The short X.Y version
@@ -40,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',
@@ -58,8 +59,8 @@ templates_path = ['_templates']
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
+source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'
@@ -111,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.
@@ -163,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 = [
@@ -191,128 +199,29 @@ intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
 autodoc_default_options = {
     'members': True,
     'show-inheritance': True,
+    # Skip these classes from the documented inheritance tree
+    'inherited-members': 'threading.Thread',
 }
 
-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,21 +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/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
@@ -66,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,58 @@
 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
+Platypush is a general-purpose automation framework that can be used to cover
-* The `Gitea page`_ of the project
+all the cases where you'd use a home automation hub, a media center, a smart
-* The `online wiki`_ for quickstart and examples
+assistant, some IFTTT recipes, and a variety of other products and services.
-* The `Blog articles`_ for inspiration on use-cases possible projects
 
-.. _main page: https://platypush.tech
+It draws inspiration from the following projects, and it aims to cover all of
-.. _Gitea page: https://git.platypush.tech/platypush/platypush
+their use-cases:
-.. _online wiki: https://git.platypush.tech/platypush/platypush/wiki
+
-.. _Blog articles: https://blog.platypush.tech
+* `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 `source code <https://git.platypush.tech/platypush/platypush>`_.
+* The `blog <https://blog.platypush.tech>`_.
+
+Wiki
+====
+
+.. toctree::
+    :maxdepth: 3
+
+    wiki/Home
+    wiki/Quickstart
+    wiki/Installation
+    wiki/Plugins-installation
+    wiki/APIs
+    wiki/Variables
+    wiki/Entities
+    wiki/Configuration
+    wiki/A-full-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/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/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/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/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/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/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/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/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.openai.rst

@@ -0,0 +1,5 @@
+``assistant.openai``
+====================
+
+.. automodule:: platypush.plugins.assistant.openai
+    :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/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:

docs/source/platypush/plugins/flic.rst

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

docs/source/platypush/plugins/github.rst

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

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

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

docs/source/platypush/plugins/google.youtube.rst

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

docs/source/platypush/plugins/gps.rst

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

docs/source/platypush/plugins/http.request.rst

@@ -1,7 +0,0 @@
-``http.request``
-==================================
-
-.. automodule:: platypush.plugins.http.request
-    :members:
-
-

docs/source/platypush/plugins/http.rst

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

docs/source/platypush/plugins/inputs.rst

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