Skip to content

feat: create install python script #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jajera merged 1 commit into from
Dec 11, 2025
Merged

feat: create install python script #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Command-line interface tools/scripts
- [install_kubectl.sh](docs/install_kubectl.md)
- [install_loki.sh](docs/install_loki.md)
- [install_promtail.sh](docs/install_promtail.md)
- [install_python.sh](docs/install_python.md)
- [install_s3_mount.sh](docs/install_s3_mount.md)
- [install_ssm_agent.sh](docs/install_ssm_agent.md)
- [install_ssm_plugin.sh](docs/install_ssm_plugin.md)
Expand Down Expand Up @@ -41,6 +42,7 @@ Refer to the respective files for detailed usage instructions:
- **[install_kubectl.sh](docs/install_kubectl.md)**: Install or uninstall `kubectl` on a Linux system.
- **[install_loki.sh](docs/install_loki.md)**: Install or uninstall Grafana Loki log aggregation system.
- **[install_promtail.sh](docs/install_promtail.md)**: Install or uninstall Grafana Promtail log shipper with flexible configuration options.
- **[install_python.sh](docs/install_python.md)**: Install or uninstall Python with version pinning support on Linux, macOS, and Windows.
- **[install_s3_mount.sh](docs/install_s3_mount.md)**: Install or uninstall AWS Mountpoint for Amazon S3 to mount S3 buckets as local filesystems.
- **[install_ssm_agent.sh](docs/install_ssm_agent.md)**: Install or uninstall the AWS Systems Manager (SSM) Agent on various Linux distributions, macOS, and Windows.
- **[install_ssm_plugin.sh](docs/install_ssm_plugin.md)**: Install or uninstall the AWS SSM Session Manager Plugin for remote EC2 access.
Expand Down
235 changes: 235 additions & 0 deletions docs/install_python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
# install_python.sh

This script installs or uninstalls Python on Linux, macOS, and Windows systems. It supports version pinning and automatically installs the latest version when no version is specified.

## Usage

```bash
./install_python.sh [install|uninstall]
```

- **install** (default): Installs Python (latest version if not specified).
- **uninstall**: Removes Python from the system.

## Optional Environment Variables

- **PYTHON_VERSION**: Pin specific version (e.g., `3.12` or `3.12.5`) or leave empty for latest

## Example Usage

To install the latest Python version:

```bash
./install_python.sh install
```

To install a specific major.minor version:

```bash
PYTHON_VERSION=3.12 ./install_python.sh install
```

To install a specific full version:

```bash
PYTHON_VERSION=3.11.5 ./install_python.sh install
```

To uninstall Python:

```bash
./install_python.sh uninstall
```

## Running Without Cloning

```bash
bash <(curl -s https://raw.githubusercontent.com/jdevto/cli-tools/main/scripts/install_python.sh) install
```

## Verification

After installation, check the Python version:

```bash
python3 --version
```

Test Python functionality:

```bash
python3 --help
```

## Supported Operating Systems

- **Linux** (Ubuntu/Debian, RHEL/CentOS/Fedora)
- **macOS** (Intel and Apple Silicon)
- **Windows** (limited support - provides instructions)

## Installation Methods by OS

### Linux (Ubuntu/Debian)

- Uses system package manager (`apt`/`apt-get`)
- For newer versions, automatically adds `deadsnakes` PPA (Ubuntu only)
- **Note**: Deadsnakes PPA is Ubuntu-only; Debian systems will need to use pyenv or build from source
- Installs `python3.x`, `python3.x-dev`, and `python3.x-venv`

### Linux (RHEL/CentOS/Fedora)

- Uses system package manager (`dnf`/`yum`)
- Attempts EPEL repository for older RHEL/CentOS systems
- Falls back to compilation instructions if version not available

### macOS

- Uses Homebrew to install `pyenv`
- Installs Python via `pyenv` for better version management
- Automatically detects shell type (zsh, bash, or fallback to `.profile`)
- Configures shell profiles with pyenv integration (only if not already configured)

### Windows

- Provides manual installation instructions
- Recommends using `pyenv-win` for version management

## Features

- Automatically detects platform and package manager
- Intelligently handles sudo (works as root or with sudo)
- Installs latest Python version when no version is specified
- Supports version pinning (major.minor or full version)
- Idempotent: skips installation if requested version is already installed
- Automatically installs required dependencies (`curl`)
- Handles multiple installation methods per OS
- Verifies installation after completion
- Validates Ubuntu-only requirements for deadsnakes PPA
- Smart shell detection for pyenv configuration on macOS

## Error Handling

- If Python with the requested version is already installed, the script will skip reinstallation.
- If an unsupported OS or architecture is detected, the script exits with an error message.
- The script checks for required dependencies before attempting installation.
- Missing dependencies are automatically installed.
- Validates that sudo is available (or runs as root) before attempting package installation.
- Checks if latest version detection succeeds before proceeding.
- Validates Ubuntu-only requirement for deadsnakes PPA on Debian-based systems.

## Version Detection

The script normalizes version numbers:

- `3.12.5` → `3.12` (major.minor)
- `3.12` → `3.12` (unchanged)
- Latest version is fetched from python.org

## Prerequisites

The script automatically installs required dependencies:

- **curl** - for fetching latest version information

### OS-Specific Prerequisites

- **macOS**: Requires Homebrew (installed automatically if needed for pyenv)
- **Linux**: Requires appropriate package manager (apt, dnf, yum)
- **Windows**: Manual installation recommended

## Idempotency

The script is idempotent and will:

- Check if Python is already installed
- Compare installed version with requested version
- Skip installation if versions match
- Proceed with installation if version differs or Python is not installed

## Troubleshooting

### Common Issues

1. **Python not found after installation**:
- Restart your shell or run `source ~/.bashrc` (or `source ~/.zshrc`)
- Verify PATH: `echo $PATH | grep python`
- Check installation: `which python3`

2. **Installation fails on Ubuntu/Debian**:
- Ensure `software-properties-common` is installed
- Check if deadsnakes PPA was added: `ls /etc/apt/sources.list.d/ | grep deadsnakes`
- **Note**: Deadsnakes PPA is Ubuntu-only. On Debian, use pyenv or build from source

3. **Installation fails on RHEL/CentOS**:
- Ensure EPEL repository is enabled: `sudo yum install epel-release`
- Some versions may require compilation from source

4. **macOS installation issues**:
- Ensure Homebrew is installed: `brew --version`
- If pyenv fails, try: `brew install python@3.12` directly

5. **Version not available**:
- System repositories may not have the latest Python versions
- Consider using `pyenv` for better version management
- Check available versions in your distribution's repositories

### Logs and Debugging

- **Check installed version**: `python3 --version`
- **Check available versions (Ubuntu)**: `apt-cache search python3 | grep '^python3'`
- **Check available versions (RHEL/Fedora)**: `dnf list available python3*`
- **Check pyenv versions (macOS)**: `pyenv versions`

### Manual Installation Methods

If the script fails, you can install Python manually:

**Ubuntu/Debian**:

```bash
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.12 python3.12-dev python3.12-venv
```

**RHEL/CentOS/Fedora**:

```bash
sudo dnf install python3.12
# Or for older systems:
sudo yum install epel-release
sudo yum install python312
```

**macOS**:

```bash
brew install pyenv
pyenv install 3.12.5
pyenv global 3.12.5
```

## Additional Resources

- **Official Python Downloads**: <https://www.python.org/downloads/>
- **pyenv (Linux/macOS)**: <https://github.com/pyenv/pyenv>
- **pyenv-win (Windows)**: <https://github.com/pyenv-win/pyenv-win>
- **deadsnakes PPA (Ubuntu)**: <https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa>

## Cleanup

- Temporary installation files are automatically removed after execution.
- The script uses `trap cleanup EXIT` to ensure cleanup even if interrupted.

## Notes

- System Python (usually `python3`) may be a system dependency and should not be removed
- The script installs additional Python versions alongside system Python
- On macOS, the script uses `pyenv` for better version management
- Windows support is limited; manual installation is recommended
- The script intelligently handles sudo - works when running as root or with sudo privileges
- **Uninstall warning**: Removing Python packages can affect system tools on non-container systems
- Deadsnakes PPA is Ubuntu-only; Debian users should use pyenv or build from source
- Shell integration for pyenv is only added if not already present (prevents duplicates)
Loading