Merge pull request #4 from SoftwareUnderstanding/update_sw_metadata_bot_v0.3

Update sw metadata bot v0.4.1

Author: Anas-Elhounsri

.gitignore

@@ -0,0 +1,2 @@
+.env
+*.pyc

.python-version

@@ -0,0 +1 @@
+3.11

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