Skip to content

Commit f13f531

Browse files
tomek-iarmada-lookout
andauthored
XS✔ ◾ Doc: Install Python for video downloader (Mac & Windows) (#981)
* docs: add Install Python for video downloader (Mac & Windows) section Adds single-line install commands for Python via Homebrew (macOS) and Chocolatey (Windows), verification steps, yt-dlp install instructions, and common PATH troubleshooting notes, per issue #638. * docs: use python3/pip3 as primary macOS commands, add Chocolatey TLS 1.2 line Homebrew installs Python as python3/pip3, so the quick-start commands using bare python/pip would fail with "command not found" on a fresh Mac. Promote python3/pip3 to the primary macOS instructions (split verify/install commands per-OS) instead of only mentioning them in the troubleshooting footnote. Also add the TLS 1.2 ServicePointManager line to the Chocolatey one-liner to match the vendor's official install script and avoid handshake failures on older PowerShell defaults, and drop the redundant nested powershell -Command wrapper. Addresses muster review major + minor findings on PR #981. --------- Co-authored-by: armada-lookout <armada-lookout@users.noreply.github.com>
1 parent 502ba86 commit f13f531

1 file changed

Lines changed: 89 additions & 0 deletions

File tree

README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,95 @@ In the root folder, run
2424
On Windows and macOS, `npm run setup` also installs the standalone `yt-dlp` binary used
2525
for YouTube downloads. This avoids relying on the operating system's Python.
2626

27+
## Install Python for video downloader (Mac & Windows)
28+
29+
[▶️ Watch the video (01:02)](https://www.youtube.com/watch?v=cW9aLi-8igc)
30+
31+
`npm run setup` installs a standalone `yt-dlp` binary automatically (see [Run](#run)), so most
32+
users don't need to install Python at all. If you hit an issue with the bundled binary, or you're
33+
running the video downloader outside the app, you can install Python and `yt-dlp` yourself with
34+
the commands below.
35+
36+
### macOS
37+
38+
Install [Homebrew](https://brew.sh/) (skip this if you already have it) and then Python, in one line:
39+
40+
```bash
41+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && brew install python
42+
```
43+
44+
If Homebrew is already installed:
45+
46+
```bash
47+
brew install python
48+
```
49+
50+
### Windows
51+
52+
Install [Chocolatey](https://chocolatey.org/install) (skip this if you already have it) and then
53+
Python, in one PowerShell command (run PowerShell **as Administrator**):
54+
55+
```powershell
56+
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')); choco install python -y
57+
```
58+
59+
If Chocolatey is already installed:
60+
61+
```powershell
62+
choco install python -y
63+
```
64+
65+
### Verify the installation
66+
67+
**macOS** (Homebrew installs Python as `python3`/`pip3`):
68+
69+
```bash
70+
python3 --version
71+
pip3 --version
72+
```
73+
74+
**Windows** (Chocolatey installs Python as `python`/`pip`):
75+
76+
```powershell
77+
python --version
78+
pip --version
79+
```
80+
81+
### Install the video downloader (yt-dlp)
82+
83+
**macOS**:
84+
85+
```bash
86+
python3 -m pip install -U yt-dlp
87+
```
88+
89+
**Windows**:
90+
91+
```powershell
92+
python -m pip install -U yt-dlp
93+
```
94+
95+
Once installed, you can run the video downloader from the command line, e.g.:
96+
97+
```bash
98+
yt-dlp "https://www.youtube.com/watch?v=example"
99+
```
100+
101+
### Common PATH issues
102+
103+
- **macOS**: if `python3`/`pip3` aren't found after installing via Homebrew, open a new terminal
104+
window (or run `source ~/.zprofile` / `source ~/.bash_profile`) so your shell picks up
105+
Homebrew's PATH changes, or confirm your Homebrew `bin` directory (`brew --prefix`) is on
106+
`PATH`.
107+
- **Windows**: if `python`/`pip` aren't recognised after installing via Chocolatey, close and
108+
reopen your terminal so the updated `PATH` environment variable is picked up. If it's still not
109+
found, verify the Python install directory and its `Scripts` folder were added to `PATH` (the
110+
Chocolatey package does this automatically, but a prior manual Python install without the "Add
111+
Python to PATH" option can shadow it — reinstall with that option checked, or add the paths
112+
manually via System Properties → Environment Variables).
113+
- On both OSes, restarting your terminal (or your machine, if PATH still doesn't refresh) after
114+
installation resolves most "command not found" issues.
115+
27116
## Building
28117

29118
1. `npm run setup` – ensure all dependencies are installed

0 commit comments

Comments
 (0)