Skip to content

📝 Doc - Install Python for video downloader (Mac & Windows) #638

Description

@tomek-i

▶️ Watch the video (01:02)

Pain

Users do not have clear, single-command instructions to install Python (required by the video downloader) on macOS and Windows. This increases friction for users who want to use the video downloader quickly.

Suggested Documentation

Add a new README section titled "Install Python for video downloader (Mac & Windows)" that provides simple, single-line CLI commands for macOS and Windows, verification steps, and instructions to install the video downloader (yt-dlp).

Tasks

  • Add README section titled "Install Python for video downloader (Mac & Windows)".
  • Add macOS command to install Homebrew if missing: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • Add macOS command to install Python using Homebrew: brew install python
  • Add Windows PowerShell command to install Chocolatey: powershell -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))"
  • Add Windows command to install Python using Chocolatey: choco install python -y
  • Add verification steps showing how to verify installation: run python --version and pip --version
  • Add instructions to install yt-dlp using Python: python -m pip install -U yt-dlp
  • Add notes about common PATH issues and troubleshooting for both OSes
  • Link the README section to the video and include example commands to run the video downloader

Acceptance Criteria

  • Meets Definition of Done - https://www.ssw.com.au/rules/definition-of-done
  • README has a new section with macOS commands documented
  • README has a new section with Windows commands documented
  • macOS single-line command has been validated on macOS
  • Windows single-line command has been validated on Windows

More Information

Recommended commands to include (examples):

macOS (single-line that installs Homebrew if needed, then Python):
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && brew install python

macOS (if Homebrew already installed):
brew install python

Windows (single-line PowerShell to install Chocolatey and Python):
powershell -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')); choco install python -y"

Verify installation:
python --version
pip --version

Install video downloader (yt-dlp):
python -m pip install -U yt-dlp

Screenshots

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: DocumentationUpdating documentation (e.g. README, Wiki, Guides etc.)YakShaverarmada:doneARMADA opened a PR for this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions