Utilities Components¶

Documentation for Utilities installation scripts.

Dependency Management Utilities¶

Description: Functions for checking and installing system dependencies like Homebrew and conda

Usage:

source dependencies.sh

Requirements: bash shell environment, internet connection

Notes: Provides automated dependency installation and verification functions

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/dependencies.sh)"

Description: Environment variable management and system configuration functions

Usage:

source environment.sh

Requirements: bash shell environment

Notes: Handles REMOTE_PS/BRANCH_PS variables, URL construction, and environment validation

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/environment.sh)"

Description: Standardized error handling, logging, and user messaging functions

Usage:

source error_handling.sh

Requirements: bash shell environment

Notes: Provides consistent error messages, logging levels, and exit handling across all scripts

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/error_handling.sh)"

Description: Loads all Python Support utilities including Piwik analytics

Usage:

source master_utils.sh

Requirements: bash shell environment, internet connection

Notes: Sources all utility modules in a single operation

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/master_utils.sh)"

Description: Enhanced analytics tracking utility for monitoring installation script usage and success rates with GDPR compliance

Usage:

source piwik_utility.sh; piwik_log "event_name" command args

Requirements: curl, internet connection

Notes: Tracks installation events to Piwik PRO for usage analytics and error monitoring with enhanced features and GDPR opt-out support

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/piwik_utility.sh)"

Description: Functions for safely downloading and sourcing remote scripts and files

Usage:

source remote_utils.sh

Requirements: curl, internet connection

Notes: Provides secure remote script execution and file downloading capabilities

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/remote_utils.sh)"

Description: Common utility functions used across all Python Support installation scripts

Usage:

source utils.sh

Requirements: bash shell environment

Notes: Provides error handling, logging, and common functionality for all components

Installation:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/dtudk/pythonsupport-scripts/main/MacOS/Components/Shared/utils.sh)"