Skip to content

Commit e233379

Browse files
committed
Explain how to use uv instead of installing python
1 parent 33ae114 commit e233379

1 file changed

Lines changed: 12 additions & 20 deletions

File tree

README.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,42 +31,34 @@ A Streamlit web app for **validating** bird species detections made by [BirdNET]
3131

3232
### Option A: One-line install (recommended)
3333

34-
> **Never used Python before? No problem!** Follow the steps below.
34+
> **Never used Python before? No problem!** You don't need to install Python — the tool below handles everything.
3535
36-
#### Step 1: Install Python
36+
#### Step 1: Install uv
3737

38-
Download and install Python from [python.org](https://www.python.org/downloads/) (version 3.10 or newer).
39-
40-
- **Windows:** Download the installer, run it, and **check the box "Add Python to PATH"** before clicking Install
41-
- **Mac:** Download the macOS installer and follow the prompts
42-
- **Linux:** Python is usually pre-installed. Check with `python3 --version`
43-
44-
#### Step 2: Install the app
45-
46-
Open a terminal (or Command Prompt on Windows) and run:
38+
[uv](https://docs.astral.sh/uv/) is a fast Python package manager that **automatically installs Python for you**. Open a terminal (or Command Prompt on Windows) and run:
4739

4840
```bash
49-
pip install git+https://github.com/NINAnor/birdnetValidator.git
50-
```
41+
# Mac / Linux
42+
curl -LsSf https://astral.sh/uv/install.sh | sh
5143

52-
This installs everything you need. It may take a minute or two.
53-
54-
#### Step 3: Launch!
44+
# Windows (PowerShell)
45+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
46+
```
5547

56-
In the same terminal, run:
48+
#### Step 2: Launch!
5749

5850
```bash
59-
birdnet-validator \
51+
uvx --from git+https://github.com/NINAnor/birdnetValidator.git birdnet-validator \
6052
--audio-dir /path/to/your/audio \
6153
--results-dir /path/to/your/birdnet/results \
6254
--output-dir /path/to/your/output
6355
```
6456

65-
Replace the paths with your actual directories. The app opens in your browser automatically. 🎉
57+
Replace the paths with your actual directories. The first run downloads dependencies (may take a minute); subsequent runs start instantly. The app opens in your browser automatically. 🎉
6658

6759
> **Windows tip:** Use backslashes in paths and put the whole command on one line:
6860
> ```
69-
> birdnet-validator --audio-dir C:\Users\me\audio --results-dir C:\Users\me\results --output-dir C:\Users\me\output
61+
> uvx --from git+https://github.com/NINAnor/birdnetValidator.git birdnet-validator --audio-dir C:\Users\me\audio --results-dir C:\Users\me\results --output-dir C:\Users\me\output
7062
> ```
7163
7264
You can also use it from a Python script:

0 commit comments

Comments
 (0)