Update README.md

This commit is contained in:
zebra 2025-06-09 21:11:28 +00:00
parent c2fbc08c3b
commit 6110146908

View File

@ -30,19 +30,19 @@ You can install the required Python packages using:
```bash ```bash
pip install requests pip install requests
```
📼 External Tools 📼 External Tools
yt-dlp: YouTube downloader for audio/video. yt-dlp: YouTube downloader for audio/video.
Install via pip (recommended): Install via pip (recommended):
```bash
pip install -U yt-dlp pip install -U yt-dlp
```
Or install system-wide: Or install system-wide:
```bash
sudo apt install yt-dlp # On Debian/Ubuntu sudo apt install yt-dlp # On Debian/Ubuntu
```
⚙️ Configuration ⚙️ Configuration
Lidarr Setup Lidarr Setup
@ -57,29 +57,29 @@ sudo apt install yt-dlp # On Debian/Ubuntu
export LIDARR_API_KEY="your-lidarr-api-key" export LIDARR_API_KEY="your-lidarr-api-key"
Or run inline: Or run inline:
```bash
LIDARR_API_KEY="your-lidarr-api-key" ./musicfetch.py "Artist - Track" LIDARR_API_KEY="your-lidarr-api-key" ./musicfetch.py "Artist - Track"
```
🧑‍💻 Usage 🧑‍💻 Usage
🔉 Download by Search Term 🔉 Download by Search Term
```bash
./musicfetch.py "Artist - Track" ./musicfetch.py "Artist - Track"
```
Example: Example:
```bash
./musicfetch.py "ODESZA - Bloom" ./musicfetch.py "ODESZA - Bloom"
```
If Lidarr finds the artist and album, it will trigger a download in Lidarr. If not, the song will be downloaded via yt-dlp using a YouTube search. If Lidarr finds the artist and album, it will trigger a download in Lidarr. If not, the song will be downloaded via yt-dlp using a YouTube search.
📺 Download by URL 📺 Download by URL
```bash
./musicfetch.py "https://www.youtube.com/watch?v=xxxxxxxxxxx" ./musicfetch.py "https://www.youtube.com/watch?v=xxxxxxxxxxx"
```
The script extracts metadata from the video and organizes the file under the artist's folder. The script extracts metadata from the video and organizes the file under the artist's folder.
📁 Output Structure 📁 Output Structure
Music is saved in: Music is saved in:
/media/music/ /base_dir/
├── Artist Name/ ├── Artist Name/
│ ├── Album Name/ (if found via Lidarr) │ ├── Album Name/ (if found via Lidarr)
│ └── youtube/ (if fallback used) │ └── youtube/ (if fallback used)