venv activation

.githooks/post-merge

@@ -43,6 +43,7 @@ warn_python_requirements() {
   echo "ATTENTION: Python requirements have changed since last pull!"
   echo ""
   echo "To update python requirements on the RPi run"
+  echo "$ source .venv/bin/activate"
   echo "$ python -m pip install --upgrade -r requirements.txt"
   echo "************************************************************"
   echo -e "\n"

.github/workflows/codeql-analysis_v3.yml

@@ -45,6 +45,9 @@ jobs:
       run: |
         # Install necessary packages
         sudo apt-get install libasound2-dev pulseaudio
+        python3 -m venv .venv
+        source ".venv/bin/activate"
+
         python -m pip install --upgrade pip
         pip install -r requirements.txt
         # Set the `CODEQL-PYTHON` environment variable to the Python executable

.github/workflows/pythonpackage_future3.yml

@@ -31,6 +31,9 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install -y libasound2-dev pulseaudio
+        python3 -m venv .venv
+        source ".venv/bin/activate"
+
         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
@@ -51,7 +54,6 @@ jobs:
         parallel: true
     - name: Lint with flake8
       run: |
-        pip3 install flake8
         # Stop the build if linting fails
         ./run_flake8.sh
 

documentation/builders/configuration.md

@@ -21,8 +21,7 @@ $ systemctl --user stop jukebox-daemon
 $ nano ./shared/settings/jukebox.yaml
 
 # Start Jukebox in console and check the log output (optional)
-$ cd src/jukebox
-$ ./run_jukebox.py 
+$ ./run_jukebox.sh
 # and if OK, press Ctrl-C and restart the service
 
 # Restart the service
@@ -32,8 +31,8 @@ $ systemctl --user start jukebox-daemon
 To try different configurations, you can start the Jukebox with a custom config file.
 This could be useful if you want your Jukebox to only allow a lower volume when started
 at night time when there is time to go to bed :-)
+The path to the custom config file must be either absolute or relativ to the folder `src/jukebox/`
 
 ```bash
-$ cd src/jukebox
-$ ./run_jukebox.py --conf path/to/custom/config.yaml
+$ ./run_jukebox.sh --conf /absolute/path/to/custom/config.yaml
 ```

documentation/builders/troubleshooting.md

@@ -64,12 +64,10 @@ on the console log.
 $ systemctl --user stop jukebox-daemon
 
 # Start the Jukebox in debug mode:
-$ cd src/jukebox
-
 # with default logger:
-$ ./run_jukebox.py
+$ ./run_jukebox.sh
 # or with custom logger configuration:
-$ ./run_jukebox.py --logger path/to/custom/logger.yaml
+$ ./run_jukebox.sh --logger path/to/custom/logger.yaml
 ```
 
 ### Fallback configuration
@@ -79,8 +77,7 @@ Attention: This only emits messages to the console and does not write to the log
 This is more a fallback features:
 
 ```bash
-$ cd src/jukebox
-$ ./run_jukebox.py -vv
+$ ./run_jukebox.sh -vv
 ```
 
 ### Extreme cases

documentation/developers/coreapps.md

@@ -10,7 +10,7 @@ $ ./<scriptname> -h
 
 ## Jukebox Core
 
-**Scriptname:** [run_jukebox.py](../../src/jukebox/run_jukebox.py)
+**Scriptname:** [run_jukebox.sh](../../run_jukebox.sh)
 
 This is the main app and starts the Jukebox Core.
 
@@ -25,15 +25,15 @@ See [Best practice procedure](../builders/configuration.md#best-practice-procedu
 
 ### Audio
 
-**Scriptname:** [run_configure_audio.py](../../src/jukebox/run_configure_audio.py)
+**Scriptname:** [setup_audio_sink.sh](../../installation/components/setup_audio_sink.sh)
 
 Setup tool to register the PulseAudio sinks as primary and secondary audio outputs.
 
 Will also setup equalizer and mono down mixer in the pulseaudio config file. Run this once after installation. Can be re-run at any time to change the settings. For more information see [Audio Configuration](../builders/audio.md).
 
 ### RFID Reader
 
-**Scriptname:** [run_register_rfid_reader.py](../../src/jukebox/run_register_rfid_reader.py)
+**Scriptname:** [setup_rfid_reader.sh](../../installation/components/setup_rfid_reader.sh)
 
 Setup tool to configure the RFID Readers.
 
@@ -46,20 +46,20 @@ Run this once to register and configure the RFID readers with the Jukebox. Can b
 
 ### RPC
 
-**Scriptname:** [run_rpc_tool.py](../../src/jukebox/run_rpc_tool.py)
+**Scriptname:** [run_rpc_tool.sh](../../tools/run_rpc_tool.sh)
 
 Command Line Interface to the Jukebox RPC Server.
 
-A command line tool for sending RPC commands to the running jukebox app. This uses the same interface as the WebUI. Can be used for additional control or for debugging. Use `./run_rpc_tool.py` to start the tool in interactive mode.
+A command line tool for sending RPC commands to the running jukebox app. This uses the same interface as the WebUI. Can be used for additional control or for debugging. Use `./run_rpc_tool.sh` to start the tool in interactive mode.
 
 The tool features auto-completion and command history.
 
 The list of available commands is fetched from the running Jukebox service.
 
-The tool can also be used to send commands directly, when passing a `-c` argument, e.g. `./run_rpc_tool.py -c host.shutdown`.
+The tool can also be used to send commands directly, when passing a `-c` argument, e.g. `./run_rpc_tool.sh -c host.shutdown`.
 
 ### Publicity Sniffer
 
-**Scriptname:** [run_publicity_sniffer.py](../../src/jukebox/run_publicity_sniffer.py)
+**Scriptname:** [run_publicity_sniffer.sh](../../tools/run_publicity_sniffer.sh)
 
 A command line tool that monitors all messages being sent out from the Jukebox via the publishing interface. Received messages are printed in the console. Mainly used for debugging.

documentation/developers/known-issues.md

@@ -21,6 +21,6 @@ RUN cd ${HOME} && mkdir ${ZMQ_TMP_DIR} && cd ${ZMQ_TMP_DIR}; \
 ## Configuration
 
 In `jukebox.yaml` (and all other config files):
-Always use relative path from settingsfile `../../`, but do not use relative paths with `~/`.
+Always use relative path from folder `src/jukebox` (`../../`), but do not use relative paths with `~/`.
 
 **Sole** exception is in `playermpd.mpd_conf`.

installation/components/setup_audio_sink.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Runner script to ensure
+# - correct venv activation
+# - independent from working directory
+
+# Change working directory to project root
+SOURCE=${BASH_SOURCE[0]}
+SCRIPT_DIR="$(dirname "$SOURCE")"
+PROJECT_ROOT="$SCRIPT_DIR"/../..
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
+
+cd src/jukebox || { echo "Could not change directory"; exit 1; }
+python run_configure_audio.py $@

installation/components/setup_rfid_reader.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Runner script to ensure
+# - correct venv activation
+# - independent from working directory
+
+# Change working directory to project root
+SOURCE=${BASH_SOURCE[0]}
+SCRIPT_DIR="$(dirname "$SOURCE")"
+PROJECT_ROOT="$SCRIPT_DIR"/../..
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
+
+cd src/jukebox || { echo "Could not change directory"; exit 1; }
+python run_register_rfid_reader.py $@

installation/routines/setup_rfid_reader.sh

@@ -1,7 +1,9 @@
 #!/usr/bin/env bash
 
 _run_setup_rfid_reader() {
-    run_and_print_lc python "${INSTALLATION_PATH}/src/jukebox/run_register_rfid_reader.py"
+    local script="${INSTALLATION_PATH}"/installation/components/setup_rfid_reader.sh
+    sudo chmod +x "$script"
+    run_and_print_lc "$script"
 }
 
 setup_rfid_reader() {

resources/default-services/jukebox-daemon.service

@@ -10,8 +10,8 @@ After=network.target sound.target mpd.service pulseaudio.service
 Requires=mpd.service pulseaudio.service
 
 [Service]
-WorkingDirectory=%%INSTALLATION_PATH%%/src/jukebox
-ExecStart=/bin/bash -c 'source %%INSTALLATION_PATH%%/.venv/bin/activate && python run_jukebox.py'
+WorkingDirectory=%%INSTALLATION_PATH%%
+ExecStart=/bin/bash -c '%%INSTALLATION_PATH%%/run_jukebox.sh'
 StandardOutput=inherit
 StandardError=inherit
 Restart=always

resources/default-settings/jukebox.default.yaml

@@ -1,5 +1,5 @@
 # IMPORTANT:
-# Always use relative path from settingsfile `../../`, but do not use relative paths with `~/`.
+# Always use relative path from folder `src/jukebox` (`../../`), but do not use relative paths with `~/`.
 # Sole (!) exception is in playermpd.mpd_conf
 system:
   box_name: Jukebox

resources/default-settings/pulseaudio.default.pa

@@ -147,5 +147,5 @@ load-module module-filter-apply
 #set-default-source input
 
 ### Configuration by Jukebox's Tool may come below
-# Run ./run_configure_audio.py for configuration
+# Run ./installation/components/run_configure_audio.sh for configuration
 

run_docgeneration.sh

@@ -1,12 +1,16 @@
 #!/usr/bin/env bash
 
-# Runner script for pydoc-markdown to ensure
+# Runner script to ensure
+# - correct venv activation
 # - independent from working directory
 
-# Change working directory to location of script
+# Change working directory to project root
 SOURCE=${BASH_SOURCE[0]}
 SCRIPT_DIR="$(dirname "$SOURCE")"
-cd "$SCRIPT_DIR" || (echo "Could not change to top-level project directory" && exit 1)
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
 
 # Run pydoc-markdown
 # make sure, directory exists

run_flake8.sh

@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
-# Runner script for flak8 to ensure
-# - correct config file
+# Runner script to ensure
+# - correct venv activation
 # - independent from working directory
 
-# Change working directory to location of script
+# Change working directory to project root
 SOURCE=${BASH_SOURCE[0]}
 SCRIPT_DIR="$(dirname "$SOURCE")"
-cd "$SCRIPT_DIR" || (echo "Could not change to top-level project directory" && exit 1)
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
 
 # Run flake8
 flake8 --config .flake8 "$@"

run_jukebox.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Runner script to ensure
+# - correct venv activation
+# - independent from working directory
+
+# Change working directory to project root
+SOURCE=${BASH_SOURCE[0]}
+SCRIPT_DIR="$(dirname "$SOURCE")"
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
+
+cd src/jukebox || { echo "Could not change directory"; exit 1; }
+python run_jukebox.py $@

run_pytest.sh

@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
-# Runner script for pytest to ensure
-# - correct config file
+# Runner script to ensure
+# - correct venv activation
 # - independent from working directory
 
-# Change working directory to location of script
+# Change working directory to project root
 SOURCE=${BASH_SOURCE[0]}
 SCRIPT_DIR="$(dirname "$SOURCE")"
-cd "$SCRIPT_DIR" || (echo "Could not change to top-level project directory" && exit 1)
+PROJECT_ROOT="$SCRIPT_DIR"
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
 
 # Run pytest
 pytest -c pytest.ini $@

src/jukebox/components/volume/__init__.py

@@ -603,7 +603,7 @@ def parse_config() -> List[PulseAudioSinkClass]:
             logger.error(f"Configured sink '{pulse_sink_name}' not available sinks '{all_sinks}!\n"
                          f"Using default sink '{default_sink_name}' as fallback\n"
                          f"Things like audio sink toggle and volume limit will not work as expected!\n"
-                         f"Please run audio config tool: ./run_configure_audio.py")
+                         f"Please run audio config tool: ./installation/components/run_configure_audio.sh")
 
         sink_list.append(PulseAudioSinkClass(alias, pulse_sink_name, volume_limit))
         key = 'secondary'

src/jukebox/run_configure_audio.py

@@ -5,7 +5,7 @@
 Will also setup equalizer and mono down mixer in the pulseaudio config file.
 
 Run this once after installation. Can be re-run at any time to change the settings.
-For more information see [Audio Configuration](../../builders/audio.md#audio-configuration).
+For more information see [Audio Configuration](./../../builders/audio.md#audio-configuration).
 """
 import os
 import argparse

src/jukebox/run_register_rfid_reader.py

@@ -3,7 +3,7 @@
 Setup tool to configure the RFID Readers.
 
 Run this once to register and configure the RFID readers with the Jukebox. Can be re-run at any time to change
-the settings. For more information see [RFID Readers](../rfid/README.md).
+the settings. For more information see [RFID Readers](./../../documentation/developers/rfid/README.md).
 
 > [!NOTE]
 > This tool will always write a new configurations file. Thus, overwrite the old one (after checking with the user).
@@ -33,7 +33,8 @@
 
 def main():
     # The default config file relative to this files location and independent of working directory
-    cfg_file_default = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/../../shared/settings/rfid.yaml')
+    script_path = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
+    cfg_file_default = os.path.abspath(os.path.join(script_path, '../../shared/settings/rfid.yaml'))
 
     parser = argparse.ArgumentParser()
     parser.add_argument("-f", "--force",

tools/run_publicity_sniffer.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Runner script to ensure
+# - correct venv activation
+# - independent from working directory
+
+# Change working directory to project root
+SOURCE=${BASH_SOURCE[0]}
+SCRIPT_DIR="$(dirname "$SOURCE")"
+PROJECT_ROOT="$SCRIPT_DIR"/..
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
+
+cd src/jukebox || { echo "Could not change directory"; exit 1; }
+python run_publicity_sniffer.py $@

tools/run_rpc_tool.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Runner script to ensure
+# - correct venv activation
+# - independent from working directory
+
+# Change working directory to project root
+SOURCE=${BASH_SOURCE[0]}
+SCRIPT_DIR="$(dirname "$SOURCE")"
+PROJECT_ROOT="$SCRIPT_DIR"/..
+cd "$PROJECT_ROOT" || { echo "Could not change directory"; exit 1; }
+
+source .venv/bin/activate || { echo "ERROR: Failed to activate virtual environment for python"; exit 1; }
+
+cd src/jukebox || { echo "Could not change directory"; exit 1; }
+python run_rpc_tool.py $@