update README and bash script to usable both with uv and with pip

Author: francoto

README.md

@@ -2,25 +2,56 @@
 
 A website to display the results of running the sw metadata bot on different organizations
 
-## Generating the Dashboard
+## Installation
 
-The landing page (`index.html`) is generated dynamically from the JSON data report using a Python script and a Mustache template.
+### Option 1: Using uv (recommended)
 
-### Requirements
+```bash
+uv sync
+```
+
+This creates/updates `.venv` and installs all project dependencies from `pyproject.toml`.
+
+### Option 2: Using pip
+
+```bash
+python -m pip install --upgrade pip
+python -m pip install "pystache>=0.6.8" "sw-metadata-bot>=0.4.1"
+```
+
+If you prefer isolated environments, create and activate a virtual environment first:
 
-You need Python 3 and the `pystache` library to generate the HTML file:
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install "pystache>=0.6.8" "sw-metadata-bot>=0.4.1"
+```
+
+## Running Analysis and Updating the Dashboard
+
+Use the helper script to run new analysis, submit issues and update the index.html:
 
 ```bash
-pip install pystache
+bash input/run_analysis.sh
 ```
 
-### How to Generate
+The script now supports two modes automatically:
 
-1. Ensure that the latest JSON report is saved as `created_issues_report.json` in this directory.
-2. Run the generation script:
+1. `uv` mode when both `uv` and `.venv/` are available
+2. `pip` fallback mode when `uv` is not available or `.venv/` does not exist
+
+In fallback mode, it installs required Python dependencies (`sw-metadata-bot`, `pystache`) with `pip` before running.
+
+## Generating Only the Landing Page
+
+If analysis output already exists, regenerate HTML pages with:
 
 ```bash
-python generate.py
+python generate_landing_page.py --config-file input/config.json
 ```
 
-This script will read the JSON data, parse it, and render it through `template.mustache` to output a the `index.html` file in the same directory.
+The generator reads snapshots from `outputs/<run_name>/<snapshot_tag>/run_report.json` and renders:
+
+1. `index.html` for the latest snapshot
+2. `history/report_<snapshot_tag>.html` for each available snapshot

input/run_analysis.sh

@@ -1,23 +1,69 @@
 #!/bin/bash
 
-# This script runs the analysis of the bot's performance and generates a report.
+# This script runs the analysis workflow and updates the dashboard.
+set -euo pipefail
 
 CONFIG_FILE="input/config.json"
-# make sure venv is up to date
-uv sync
 
-# run analysis using the bot's command line interface
-uv run sw-metadata-bot run-analysis --config-file $CONFIG_FILE
+USE_UV=false
+if command -v uv >/dev/null 2>&1 && [ -d ".venv" ]; then
+	USE_UV=true
+fi
+
+if [ "$USE_UV" = true ]; then
+	echo "Using uv environment (.venv detected)."
+	uv sync
+else
+	echo "Using pip fallback (uv missing or .venv not found)."
+
+	if [ -x ".venv/bin/python" ]; then
+		PYTHON_BIN=".venv/bin/python"
+	elif command -v python3 >/dev/null 2>&1; then
+		PYTHON_BIN="python3"
+	elif command -v python >/dev/null 2>&1; then
+		PYTHON_BIN="python"
+	else
+		echo "Error: No Python interpreter found."
+		exit 1
+	fi
+
+	"$PYTHON_BIN" -m pip install --upgrade pip
+	"$PYTHON_BIN" -m pip install "pystache>=0.6.8" "sw-metadata-bot>=0.4.1"
+fi
+
+if [ "$USE_UV" = true ]; then
+	uv run sw-metadata-bot run-analysis --config-file "$CONFIG_FILE"
+else
+	"$PYTHON_BIN" -m sw_metadata_bot.main run-analysis --config-file "$CONFIG_FILE"
+fi
 
 echo "Analysis completed. Publishing results to respective repositories..."
 
-OUTPUT_DIR=$(uv run python -c "import read_config; config = read_config.read_config('$CONFIG_FILE'); print(read_config.get_output_folder(config))")
-# get latest subfolder created from config file
-LATEST_SUBFOLDER=$(ls -td $OUTPUT_DIR/*/ | head -1)
+if [ "$USE_UV" = true ]; then
+	OUTPUT_DIR=$(uv run python -c "import read_config; config = read_config.read_config('$CONFIG_FILE'); print(read_config.get_output_folder(config))")
+else
+	OUTPUT_DIR=$(
+		"$PYTHON_BIN" -c "import read_config; config = read_config.read_config('$CONFIG_FILE'); print(read_config.get_output_folder(config))"
+	)
+fi
+
+# Get latest snapshot folder from output directory.
+LATEST_SUBFOLDER=$(ls -td "$OUTPUT_DIR"/*/ | head -1)
+if [ -z "${LATEST_SUBFOLDER:-}" ]; then
+	echo "Error: No snapshot folder found under $OUTPUT_DIR"
+	exit 1
+fi
+
+if [ "$USE_UV" = true ]; then
+	uv run sw-metadata-bot publish --analysis-root "$LATEST_SUBFOLDER"
+else
+	"$PYTHON_BIN" -m sw_metadata_bot.main publish --analysis-root "$LATEST_SUBFOLDER"
+fi
 
-# publish results to github pages
-uv run sw-metadata-bot publish --analysis-root $LATEST_SUBFOLDER/
 echo "Issues submitted to the repositories"
 
-# generate landing page
-uv run python generate_landing_page.py
+if [ "$USE_UV" = true ]; then
+	uv run python generate_landing_page.py --config-file "$CONFIG_FILE"
+else
+	"$PYTHON_BIN" generate_landing_page.py --config-file "$CONFIG_FILE"
+fi