Skip to content

Building 70 Projects ranging from beginner to advanced so anyone can β€” learn from, build upon, use as a reference, or even copy directly. Owned by my cybersecurity company πŸ‘‡

7.2 KB
Raw Blame
#!/usr/bin/env bash
# Β©AngelaMos | 2026
# install.sh
#
# Zero-friction install script. Anyone who clones this project should
# be able to run `./install.sh` and end up with a working setup,
# regardless of whether they have uv or just installed yet.
#
# What this script does, in order:
#   1. Verifies Python 3.13+ is installed (we need modern type-hint syntax)
#   2. Installs uv if it is missing (uv is the Python package manager we use)
#   3. Installs just if it is missing (just is the command runner)
#   4. Calls `just setup` to create the venv and install dependencies
#   5. Prints next steps
#
# Run with:  ./install.sh
# Or:        bash install.sh

# -----------------------------------------------------------------------------
# Bash safety flags β€” fail fast and loud
# -----------------------------------------------------------------------------
# -e : exit immediately if any command returns a non-zero (error) status
# -u : treat unset variables as an error
# -o pipefail : if any command in a pipeline fails, the whole pipeline fails
set -euo pipefail

# -----------------------------------------------------------------------------
# Color helpers β€” pretty terminal output without external dependencies
# -----------------------------------------------------------------------------
# These are ANSI escape codes. \033 is the ESC character; the bracketed
# digits tell the terminal which color to switch to. NC = "no color",
# resets back to whatever the terminal had before.
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
RED='\033[0;31m'
NC='\033[0m'

# Tiny helper functions so we don't repeat the format strings everywhere.
# `>&2` redirects to stderr (where errors belong) instead of stdout.
info()    { echo -e "${GREEN}[INFO]${NC} $1"; }
warn()    { echo -e "${YELLOW}[WARN]${NC} $1"; }
error()   { echo -e "${RED}[ERROR]${NC} $1" >&2; }
success() { echo -e "${GREEN}[OK]${NC} $1"; }

# -----------------------------------------------------------------------------
# Step 1 β€” Confirm Python 3.13+ is on the system
# -----------------------------------------------------------------------------
check_python() {
    info "Checking for Python 3.13+..."

    # `command -v <name>` prints the path of <name> if it exists, nothing
    # otherwise. `&>/dev/null` discards both stdout and stderr β€” we only
    # care about the exit code (0 = found, non-zero = missing).
    if ! command -v python3 &>/dev/null; then
        error "python3 not found. Please install Python 3.13 or newer."
        error "  macOS:  brew install [email protected]"
        error "  Linux:  sudo apt install python3.13   (Debian/Ubuntu)"
        error "  Windows: download from python.org"
        exit 1
    fi

    # Read the version from Python itself β€” the most reliable source.
    # `local` makes these variables function-scoped instead of leaking
    # into the rest of the script.
    local version
    version=$(python3 -c 'import sys; print(f"{sys.version_info.major}.{sys.version_info.minor}")')

    local major minor
    # `cut -d. -f1` splits the string on `.` and takes field 1.
    major=$(echo "$version" | cut -d. -f1)
    minor=$(echo "$version" | cut -d. -f2)

    # `(( ... ))` is bash arithmetic context β€” lets us write `<` `>` etc.
    # The compound condition fails if major < 3, OR if major == 3 and
    # minor < 13. So Python 3.12 fails, 3.13 passes, 4.0 passes.
    if (( major < 3 )) || { (( major == 3 )) && (( minor < 13 )); }; then
        error "Python 3.13+ is required, found Python $version"
        exit 1
    fi

    success "Python $version detected"
}

# -----------------------------------------------------------------------------
# Step 2 β€” Install uv if missing (https://docs.astral.sh/uv)
# -----------------------------------------------------------------------------
install_uv() {
    # Already installed? Print confirmation and bail out of this function.
    # `return 0` exits the function with success β€” the caller continues.
    if command -v uv &>/dev/null; then
        success "uv already installed ($(uv --version))"
        return 0
    fi

    info "Installing uv (Python package manager)..."
    # Pipe the official install script into sh. `-LsSf`:
    #   -L : follow redirects
    #   -s : silent (no progress meter)
    #   -S : show errors even when silent
    #   -f : fail on HTTP errors instead of writing them to disk
    curl -LsSf https://astral.sh/uv/install.sh | sh

    # The installer drops uv into ~/.local/bin or ~/.cargo/bin.
    # Add both to PATH for the rest of THIS script's run.
    export PATH="$HOME/.local/bin:$HOME/.cargo/bin:$PATH"

    # If we still cannot find uv, something went wrong.
    if ! command -v uv &>/dev/null; then
        error "uv install completed but \`uv\` is still not on PATH."
        error "Restart your shell and re-run this script, or add uv to PATH manually."
        exit 1
    fi
    success "uv installed"
}

# -----------------------------------------------------------------------------
# Step 3 β€” Install just if missing (https://github.com/casey/just)
# -----------------------------------------------------------------------------
install_just() {
    if command -v just &>/dev/null; then
        success "just already installed ($(just --version))"
        return 0
    fi

    info "Installing just (command runner)..."
    # Make sure the install destination exists first.
    mkdir -p "$HOME/.local/bin"
    # Official install script. `--to <dir>` controls where the binary lands.
    # `--proto '=https'` rejects any protocol but HTTPS.
    # `--tlsv1.2` insists on a modern TLS version.
    curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh \
        | bash -s -- --to "$HOME/.local/bin"

    export PATH="$HOME/.local/bin:$PATH"
    success "just installed"
}

# -----------------------------------------------------------------------------
# Step 4 β€” Use just to set up the project (venv + dependencies)
# -----------------------------------------------------------------------------
project_setup() {
    info "Running 'just setup'..."
    # Calling our own justfile recipe β€” single source of truth for setup.
    just setup
}

# -----------------------------------------------------------------------------
# Main β€” orchestrate the steps and print next instructions
# -----------------------------------------------------------------------------
main() {
    echo ""
    echo "================================================"
    echo "  hash-identifier β€” install"
    echo "================================================"
    echo ""

    check_python
    install_uv
    install_just
    project_setup

    echo ""
    echo "================================================"
    success "Install complete!"
    echo "================================================"
    echo ""
    echo "Next steps:"
    echo "  just run -- 5f4dcc3b5aa765d61d8327deb882cf99   # identify a hash"
    echo "  just run -- --help                              # see options"
    echo "  just test                                       # run the test suite"
    echo ""
}

# `"$@"` forwards every argument the script was called with into main.
# We do not use any args today, but keeping this pattern means future
# flags can be added without changing the bottom of the file.
main "$@"