Skip to content

Commit ea77905

Browse files
authored
Merge pull request Azure#635 from Azure/canary
Canary
2 parents 9428105 + 3bd287f commit ea77905

File tree

1 file changed

+51
-8
lines changed

1 file changed

+51
-8
lines changed

scripts/python/url-checker/README.md

+51-8
Original file line numberDiff line numberDiff line change
@@ -50,20 +50,63 @@ Or using the requirements file:
5050
pip install -r requirements.txt
5151
```
5252

53-
## 🛠️ Manual Usage
53+
## 🐍 Python 3 Installation
5454

55-
Run from the repository root:
55+
If you don't have Python 3 installed, here's how to install it on different operating systems:
56+
57+
### Windows
58+
59+
1. Download the latest Python installer from the [official Python website](https://www.python.org/downloads/windows/)
60+
2. Run the installer
61+
3. Make sure to check "Add Python to PATH" during installation
62+
4. Verify the installation by opening Command Prompt and typing:
63+
```
64+
python --version
65+
```
66+
67+
### macOS
68+
69+
Using Homebrew (recommended):
70+
```bash
71+
brew install python
72+
```
73+
74+
Or download the installer from the [official Python website](https://www.python.org/downloads/macos/)
5675

76+
Verify the installation:
5777
```bash
58-
python scripts/python/url-checker/url-checker.py
78+
python3 --version
5979
```
6080

61-
Optional arguments:
81+
### Linux (Ubuntu/Debian)
82+
83+
```bash
84+
sudo apt update
85+
sudo apt install python3 python3-pip
86+
```
87+
88+
Verify the installation:
89+
```bash
90+
python3 --version
6291
```
63-
--verbose Show more detailed output
64-
--paths [PATH...] Specify specific paths to check
65-
--skip-external Skip checking external URLs (faster)
66-
--format [FORMAT] Output format (text, json, csv)
92+
93+
### Linux (RHEL/CentOS/Fedora)
94+
95+
```bash
96+
sudo dnf install python3 python3-pip
97+
```
98+
99+
Verify the installation:
100+
```bash
101+
python3 --version
102+
```
103+
104+
## 🛠️ Manual Usage
105+
106+
Run from the repository root:
107+
108+
```bash
109+
python3 scripts/python/url-checker/url-checker.py
67110
```
68111

69112
## 🚂 Performance Optimization

0 commit comments

Comments
 (0)