Task-311 Update setup.sh to be easier to use.

app.py

@@ -331,7 +331,7 @@ with tab2:
         * **<a href="https://github.com/dlsmallw/NLPinitiative" style="text-decoration:none"><img src="https://raw.githubusercontent.com/tandpfun/skill-icons/refs/heads/main/icons/Github-Dark.svg" style="margin-right: 3px;" width="20" height="20"/> NLPinitiative GitHub Project</a>**  - The training/evaluation pipeline used for fine-tuning the models.
         * **<a href="https://huggingface.co/{BIN_REPO}" style="text-decoration:none">🤗 NLPinitiative HF Binary Classification Model Repository</a>** - The Hugging Face hosted Binary Classification Model Repository.
         * **<a href="https://huggingface.co/{ML_REPO}" style="text-decoration:none">🤗 NLPinitiative HF Multilabel Regression Model Repository</a>** - The Hugging Face hosted Multilabel Regression Model Repository.
-        * **<a href="https://huggingface.co/{DATASET_REPO}" style="text-decoration:none">🤗 NLPinitiative HF Dataset Repository</a>** - The Hugging Face hosted Dataset Repository.
+        * **<a href="https://huggingface.co/datasets/{DATASET_REPO}" style="text-decoration:none">🤗 NLPinitiative HF Dataset Repository</a>** - The Hugging Face hosted Dataset Repository.
 
         <hr style="margin: 0 0 0.5em 0;">
 

setup.sh

@@ -1,41 +1,143 @@
 #!/usr/bin/bash
 
+# =======================
+# ===  Color Loggers  ===
+# =======================
+GREEN='\033[1;32m'; YELLOW='\033[1;33m'; RED='\033[1;31m'; BLUE='\033[1;34m'; CYAN='\033[1;36m'; NC='\033[0m'
+
+log_info()   { echo -e "${GREEN}[INFO] $1${NC}"; }
+log_warn()   { echo -e "${YELLOW}[WARN] $1${NC}"; }
+log_error()  { echo -e "${RED}[ERROR] $1${NC}"; }
+log_help()   { echo -e "${CYAN}$1${NC}"; }
+
+# =========================
+# === Sourced-Only Check ==
+# =========================
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+    log_error "Please source this script instead of running it directly:"
+    echo "    source ./scripts/setup.sh"
+    exit 1
+fi
+
+# ======================
+# === Project Paths  ===
+# ======================
+ROOT="$( cd "$( dirname "${BASH_SOURCE[1]}" )/.." && pwd )"
+PROJECT_ROOT="$ROOT/NLPinitiative-Streamlit-App"
+
+# ================================
+# ===   Python Version Check   ===
+# ================================
+check_python_version() {
+    REQUIRED="3.7"
+    if ! command -v python3 &> /dev/null; then
+        log_warn "python3 not found. Python >= 3.7 is recommended if you need Python tasks."
+    else
+        local PY_VER
+        PY_VER=$(python3 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
+        if [[ $(printf '%s\n' "$REQUIRED" "$PY_VER" | sort -V | head -n1) != "$REQUIRED" ]]; then
+            log_warn "Detected Python version: $PY_VER (older than $REQUIRED). Consider upgrading."
+        else
+            log_info "Detected Python version: $PY_VER"
+        fi
+    fi
+}
+
+# =================================
+# ===  pipenv Check (No Prompt) ===
+# =================================
+check_pipenv() {
+    if ! command -v pipenv &> /dev/null; then
+        log_warn "pipenv not found. Install via 'pip install pipenv'."
+    else
+        log_info "Detected pipenv."
+    fi
+}
+
+# =======================================
+# ===   Virtual Env Existence Check   ===
+# =======================================
+check_virtualenv() {
+    cd "$PROJECT_ROOT" || return 1
+
+    if [ -d ./.venv ]; then
+        log_info "Local .venv found. Activating venv..."
+        source .venv/Scripts/activate
+        log_info "Virtual Environment Activated."
+    else
+        log_warn "No local .venv found. Run 'build' to create and activate a local venv."
+    fi
+}
+
+# ============================
+# ===    Build Function    ===
+# ============================
 build() {
+    cd "$PROJECT_ROOT" || return 1
+    log_info "Running 'build': Cleaning project and then rebuilding virtual environment..."
+
     clean 
 
+    log_info "Setting up new Virtual Environment..."
     python -m venv .venv
+
+    log_info "Activating Virtual Environment..."
     source .venv/Scripts/activate
+
+    log_info "Loading dependencies..."
     pip install pipenv
     pipenv install
+
+    log_info "Build Complete."
 }
 
+# ========================
+# ===  Clean Function  ===
+# ========================
 clean() {
+    cd "$PROJECT_ROOT" || return 1
+    log_info "Running 'clean': Removing .venv and any python cache and compiled binary files."
+
     if [ -n "$VIRTUAL_ENV" ]; then
+        log_info "Deactivating Virtual Environment..."
         deactivate
+        log_info "Virtual Environment Deactivated."
     fi
 
     if [ -d ./.venv ]; then
+        log_info "Removing .venv directory..."
         rm -rf ./.venv
+        log_info "Removed .venv directory."
     fi
 
+    log_info "Removing cache and compiled binary files..."
     find . -type f -name "*.py[co]" -delete
 	find . -type d -name "__pycache__" -delete
-}
+    log_info "Cache and compiled binary files removed."
 
-requirements() {
-    pipenv requirements > requirements.txt
+    log_info "Clean Complete."
 }
 
+# ============================
+# === Generate Docs Command ==
+# ============================
 docs() {
+    cd "$PROJECT_ROOT" || return 1
+
     case $1 in
         build)
+            log_info "Building documentation..."
             mkdocs build
+            log_info "Documentation built."
             ;;
         serve)
+            log_info "Serving documentation..."
             mkdocs serve
             ;;
         deploy)
+            log_info "Deploying documentation to GH Pages..."
             mkdocs gh-deploy --force
+            log_info "Documentation deployed to GH Pages."
             ;;
         *)
             log_error "Specify 'build', 'serve' or 'deploy'. For example: docs build"
@@ -43,9 +145,25 @@ docs() {
     esac
 }
 
+# ============================
+# === Generate Requirements ==
+# ============================
+requirements() {
+    cd "$PROJECT_ROOT" || return 1
+
+    log_info "Generating requirements.txt..."
+    pipenv requirements > requirements.txt
+    log_info "requirements.txt file generated."
+}
+
+# ============================
+# ===    Config Settings   ===
+# ============================
 set() {
+    cd "$PROJECT_ROOT" || return 1
+
     if [[ $# -lt 2 ]]; then
-        echo "Command Requires Two Arguments."
+        log_error "Set Command Requires Two Arguments."
     else
         case $1 in
             bin_repo)
@@ -58,19 +176,63 @@ set() {
                 python ./scripts/config.py -d "$2"
                 ;;
             *)
-                log_error "Specify 'bin_repo', 'ml_repo' or 'ds_repo'. For example: set bin_repo <repo id>"
+                log_error "Invalid set option."
+                echo "Available 'set' options:"
+                echo "  bin_repo <repo ID>          - Sets the binary model's repo ID in the pyproject.toml file."
+                echo "  ml_repo <repo ID>           - Sets the multilabel model's repo ID in the pyproject.toml file."
+                echo "  ds_repo <repo ID>           - Sets the dataset repo ID in the pyproject.toml file."
                 ;;
         esac
     fi
 }
 
+# ============================
+# ===    Running the App   ===
+# ============================
 run() {
     case $1 in
         dev)
+            log_info "Running the Streamlit app in a local dev environment..."
             streamlit run app.py
             ;;
         *)
             log_error "Specify 'dev'. For example: run dev"
             ;;
     esac
-}
+}
+
+# ============================
+# ===     Help Command     ===
+# ============================
+help() {
+    cd "$PROJECT_ROOT" || return 1
+
+    log_help "Usage: source ./scripts/setup.sh"
+    echo "Available commands:"
+    echo "  Miscellaneous commands:"
+    echo "      help        - Show this help message."
+    echo "==========================================="
+    echo "  Project Building, Cleaning, etc. commands:"
+    echo "      build       - Cleans and reinstalls Python dependencies."
+    echo "      clean       - Cleans project (i.e., deactivates venv, removes .venv and clears project of python cache and binary files)."
+    echo "      run dev     - Runs the application in a local dev environment."
+    echo "==========================================="
+    echo "  'docs' command options:"
+    echo "      docs build      - Generates mkdocs for the project."
+    echo "      docs serve      - Serves documentation locally."
+    echo "      docs deploy     - Deploys documentation to associated GH Pages."
+    echo "==========================================="
+    echo "  'set' command options:"
+    echo "      set bin_repo <repo ID>          - Sets the binary model's repo ID in the pyproject.toml file."
+    echo "      set ml_repo <repo ID>           - Sets the multilabel model's repo ID in the pyproject.toml file."
+    echo "      set ds_repo <repo ID>           - Sets the dataset repo ID in the pyproject.toml file."
+}
+
+log_info "Loading setup.sh script..."
+
+check_python_version
+check_pipenv
+check_virtualenv
+
+log_info "setup.sh loaded. Type 'help' for usage."
+log_info "Try 'build' then 'run dev' to get started."