Improve the run_rpc_tool script

.dockerignore

@@ -0,0 +1,16 @@
+.git
+.githooks
+.github
+.dockerignore
+.DS_Store
+
+# Application
+docker
+docs
+shared
+
+# webapp
+!src/webapp
+src/webapp/node_modules
+src/webapp/npm-debug.log
+src/webapp/build

.editorconfig

@@ -14,3 +14,6 @@ indent_size = 4
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.{js,yaml}]
+indent_size = 2

.flake8

@@ -1,7 +1,25 @@
 [flake8]
-max-line-length = 120
+max-line-length = 127
 ignore =
     # continuation line over-indented for visual indent
     E127,
     # continuation line under-indented for visual indent
-    E128
+    E128,
+    # line break before binary operator
+    W503
+per-file-ignores =
+    # Only in __init__files ignore imported but unused
+    # Not necessary, if __all__ is declared in __init__ file
+    # https://www.python.org/dev/peps/pep-0008/#id48
+    __init__.py:F401
+count = True
+max-complexity = 12
+statistics = True
+filename = *.py,*.py.*
+extend-exclude =
+    # Ignore all scratch development directories
+    scratch*,
+    # Ignore dirs and files that have not been ported yet
+    */jukebox/NvManager.py
+    # ignore GitHub Codespaces
+    .venv/*

.githooks/post-merge

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+# Script to be run by git hook: post merge, i.e. git pull
+#
+# TO ACTIVATE: cp .githooks/post-merge .git/hooks/.
+#
+# Checks:
+# - Changes to web app
+# - Changes to web dependency
+# - Changes to python requirements
+#
+# Actions are not triggered automatically as they can take some
+# time. The user is warned if an action is required.
+#
+# Inspired by
+# https://davidwalsh.name/git-hook-npm-install-package-json-modified
+
+warn_npm_dependency() {
+  echo -e "\n"
+  echo "************************************************************"
+  echo "ATTENTION: npm dependencies have changed since last pull!"
+  echo ""
+  echo "To update dependencies and rebuilt WebApp run:"
+  echo "$ cd src/webapp && ./run_rebuild.sh -u"
+  echo "************************************************************"
+  echo -e "\n"
+}
+
+warn_webapp() {
+  echo -e "\n"
+  echo "************************************************************"
+  echo "ATTENTION: Web App sources have changed since last pull!"
+  echo ""
+  echo "To rebuilt the WebApp run:"
+  echo "$ cd src/webapp && ./run_rebuild.sh"
+  echo "************************************************************"
+  echo -e "\n"
+}
+
+warn_python_requirements() {
+  echo -e "\n"
+  echo "************************************************************"
+  echo "ATTENTION: Python requirements have changed since last pull!"
+  echo ""
+  echo "To update python requirements on the RPi run"
+  echo "$ python -m pip install --upgrade -r requirements.txt"
+  echo "************************************************************"
+  echo -e "\n"
+}
+
+warn_githooks() {
+  echo -e "\n"
+  echo "************************************************************"
+  echo "ATTENTION: Recommended git hooks changed!"
+  echo ""
+  echo "To update, REVIEW and copy .githooks/* to .git/hooks"
+  echo "$ cp .githooks/* .git/hooks/."
+  echo "************************************************************"
+  echo -e "\n"
+
+}
+
+# files_changed="$(git diff-tree -r --name-only --no-commit-id ORIG_HEAD HEAD)"
+webapp_changed="$(git diff-tree -r --name-only --no-commit-id ORIG_HEAD HEAD src/webapp)"
+webapp_dep_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD src/webapp/package.json)"
+python_req_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD requirements.txt)"
+githooks_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD .githooks)"
+
+if [[ -n $python_req_changed ]]; then
+    warn_python_requirements
+fi
+
+if [[ -n $webapp_dep_changed ]]; then
+    warn_npm_dependency
+elif [[ -n $webapp_changed ]]; then
+    warn_webapp
+fi
+
+if [[ -n $githooks_changed ]]; then
+    warn_githooks
+fi
+
+echo -e "\nTo see a summary of what happened since your last pull, do:"
+echo -e "git show --oneline -s ORIG_HEAD..HEAD\n"

.githooks/pre-commit

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# Script to be run by git hook: pre-commit
+#
+# TO ACTIVATE: cp .githooks/pre-commit .git/hooks/.
+#
+# Checks
+# - flake8 on staged python files
+#   Note: This only checks the modified files
+# - docs build of if any python file or any doc file is staged
+#   Note: This builds the entire documentation if a changed file goes into the documentation
+#
+# If there are problem with this script, commit may still be done with
+# git commit --no-verify
+
+
+# Pass all staged python files through flake8
+PY_FILES="$(git diff --diff-filter=d --staged --name-only -- **/*.py)"
+flake8_code=0
+if [[ -n $PY_FILES ]]; then
+  echo -e "\n**************************************************************"
+  echo "Modified Python source files. Running flake8 ... "
+  echo -e "**************************************************************\n"
+  ./run_flake8.sh $PY_FILES
+  flake8_code=$?
+  echo "Flake8 return code: $flake8_code"
+fi
+
+code=$(( flake8_code ))
+
+if [[ code -gt 0 ]]; then
+  echo -e "\n**************************************************************"
+  echo -e "ERROR(s) during pre-commit checks. Aborting commit!"
+  echo -e "**************************************************************\n"
+fi
+
+exit $code
+

.github/ISSUE_TEMPLATE/bug_template.md

@@ -50,7 +50,7 @@ Otherwise the output of `cat /etc/os-release`
 i.e. `master`
 
 the following command will help with that
-`cd /home/pi/RPi-Jukebox-RFID/ && git status | head -2`
+`cd ~/RPi-Jukebox-RFID/ && git status | head -2`
 -->
 
 ### Installscript

.github/ISSUE_TEMPLATE/future3.md

@@ -0,0 +1,8 @@
+---
+name: Future3 Development Issue
+about: For developing issues on Future3 (Version 3 pre-development)
+title: "ISSUE SUMMARY on Future3"
+labels: future3, bug, needs triage
+---
+
+## Issue in Future3

.github/dependabot.yml

@@ -0,0 +1,26 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/pythonpackage_future3.yml

@@ -0,0 +1,48 @@
+name: Python + Docs Checks and Tests
+
+on:
+  push:
+    branches:
+        - 'future3/**'
+    paths:
+        - '**.py'
+        - '**.py.*'
+  pull_request:
+    branches:
+        - 'future3/**'
+    paths:
+        - '**.py'
+        - '**.py.*'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libasound2-dev pulseaudio
+        python3 -m pip install --upgrade pip
+        pip3 install -r requirements.txt
+        # For operation of the Jukebox, ZMQ must be compiled from sources due to Websocket support
+        # Also install all optional dependencies
+        pip3 install -r src/jukebox/components/rfid/hardware/fake_reader_gui/requirements.txt
+        pip3 install -r src/jukebox/components/rfid/hardware/pn532_i2c_py532/requirements.txt
+        pip3 install -r src/jukebox/components/rfid/hardware/rdm6300_serial/requirements.txt
+        pip3 install -r src/jukebox/components/rfid/hardware/rc522_spi/requirements.txt
+    - name: Lint with flake8
+      run: |
+        pip3 install flake8
+        # Stop the build if linting fails
+        ./run_flake8.sh