pushing changes

Author: arsalan-dev-engineer

scripting_tools/setup.sh

@@ -1,86 +1,67 @@
 #!/bin/bash
 
-# Enhanced Python virtual environment setup script with global zap-cli and global package installation
-set -e
+# Python virtual environment setup script with zap-cli global symlink
 
-# Colors for output
-GREEN='\033[0;32m'
-RED='\033[0;31m'
-YELLOW='\033[1;33m'
-NC='\033[0m' # No Color
+set -euo pipefail
 
-# Automatically detect the script's root directory dynamically
-SCRIPT_DIR="$(dirname "$(realpath "$0")")"
-ROOT_DIR="$HOME"  # Set root directory to user's home directory
-
-# Define the virtual environment directory and requirements file path
+ROOT_DIR="$HOME"
 VENV_DIR="${ROOT_DIR}/venv"
 REQUIREMENTS_FILE="${ROOT_DIR}/requirements.txt"
 ZAP_CLI_PATH="${ROOT_DIR}/zap_cli.py"
 
-# Check if Python3 is installed
-if ! command -v python3 &> /dev/null; then
-    echo -e "${RED}Error: Python3 is not installed. Please install Python3 and try again.${NC}"
+error_exit() {
+    echo "Error: $1"
     exit 1
-fi
+}
+
+info() {
+    echo "[INFO] $1"
+}
 
-# Check if the python3-venv package is installed, and install it if missing
-if ! dpkg -s python3-venv &> /dev/null; then
-    echo -e "${YELLOW}Installing python3-venv...${NC}"
+command -v python3 >/dev/null || error_exit "Python3 is not installed."
+
+if command -v dpkg &> /dev/null && ! dpkg -s python3-venv &> /dev/null; then
+    info "Installing python3-venv..."
     sudo apt update && sudo apt install -y python3-venv
 fi
 
-# If the requirements file is not found, search for it in the parent directory
 if [ ! -f "$REQUIREMENTS_FILE" ]; then
-    echo -e "${YELLOW}Requirements file not found in $ROOT_DIR. Searching in subdirectories...${NC}"
+    info "requirements.txt not found. Searching..."
     REQUIREMENTS_FILE=$(find "$ROOT_DIR" -name "requirements.txt" -print -quit)
-
-    if [ -z "$REQUIREMENTS_FILE" ]; then
-        echo -e "${RED}Error: requirements.txt not found.${NC}"
-        exit 1
-    else
-        echo -e "${YELLOW}Found requirements.txt at $REQUIREMENTS_FILE.${NC}"
-    fi
+    [ -z "$REQUIREMENTS_FILE" ] && error_exit "requirements.txt not found."
+    info "Found requirements.txt at $REQUIREMENTS_FILE."
 fi
 
-# Create or recreate the virtual environment
 if [ ! -d "$VENV_DIR" ]; then
-    echo -e "${YELLOW}Creating virtual environment at $VENV_DIR...${NC}"
+    info "Creating virtual environment at $VENV_DIR..."
     python3 -m venv "$VENV_DIR"
 else
-    echo -e "${GREEN}Virtual environment already exists at $VENV_DIR.${NC}"
+    info "Virtual environment already exists at $VENV_DIR."
 fi
 
-# Activate the virtual environment
-echo -e "${YELLOW}Activating the virtual environment...${NC}"
 source "$VENV_DIR/bin/activate"
 
-# Upgrade pip and install dependencies from requirements.txt
-echo -e "${YELLOW}Upgrading pip and installing packages in the virtual environment...${NC}"
+info "Upgrading pip and installing packages..."
 pip install --upgrade pip
 pip install -r "$REQUIREMENTS_FILE"
 
-# Create a symlink for the zap-cli command globally
+# Create symlink
 if [ -f "$ZAP_CLI_PATH" ]; then
-    echo -e "${YELLOW}Creating global symlink for zap-cli...${NC}"
-    sudo ln -sf "$ZAP_CLI_PATH" /usr/local/bin/zap-cli
+    if [ ! -L /usr/local/bin/zap-cli ]; then
+        sudo ln -s "$ZAP_CLI_PATH" /usr/local/bin/zap-cli
+        echo "[INFO] zap-cli command created."
+    else
+        echo "[INFO] zap-cli command already exists."
+    fi
 else
-    echo -e "${RED}Error: zap-cli.py not found at $ZAP_CLI_PATH.${NC}"
     deactivate
-    exit 1
+    error_exit "zap_cli.py not found at $ZAP_CLI_PATH."
 fi
 
-# Install pip packages globally (if any additional packages need to be globally installed)
-echo -e "${YELLOW}Installing global pip packages...${NC}"
-sudo pip install -r "$REQUIREMENTS_FILE"  # Install globally
-
-# Final messages
-echo -e "${GREEN}Setup complete. Virtual environment is ready to use.${NC}"
-echo -e "${GREEN}To activate the virtual environment manually, run:${NC}"
-echo -e "${GREEN}source ${VENV_DIR}/bin/activate${NC}"
-
-echo -e "${GREEN}You can now run the CLI with:${NC}"
-echo -e "${GREEN}zap-cli --help${NC}"
+info "Setup complete."
+info "To activate the virtual environment manually, run:"
+echo "source ${VENV_DIR}/bin/activate"
+info "You can now run:"
+echo "zap-cli --help"
 
-# Deactivate the virtual environment
 deactivate

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 """
-setup.py fo dev-cli
+setup.py for zap-cli
 
 This script is used to package and distribute the zap-cli project.
 It includes details like the package name, version, dependencies, 
@@ -40,4 +40,6 @@
         'Operating System :: OS Independent',
     ],
     python_requires='>=3.6',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
 )