summaryrefslogtreecommitdiff
path: root/README.md
blob: 61860b2b4993a395cba30ba5ec3e468c48a1d765 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Pamus
This script allows you to download audio files from YouTube Music based on a list of song names, and it also tags the downloaded files with relevant metadata (such as title, artist, album, genre).

## Dependencies:
- [Python 3](https://www.python.org)
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
- [mutagen](https://mutagen.readthedocs.io/en/latest/)
- [ytmusicapi](https://ytmusicapi.readthedocs.io/en/stable/)

## Help
For help, run:
```Bash
pamus -h 
```

## Install
Simply run:
``` Bash
sudo make
```
## Usage Examples

1. Using Input File:  
   To download songs listed in the input file (`$HOME/.config/pamus/list.txt`) to the default output directory (`$HOME/music`) in mp3 format:
   ```bash
   pamus
   ```

2. Specifying Songs Directly:  
   To download songs provided directly on the command line:
   ```bash
   pamus -s "Song Name 1" "Song Name 2" "Song Name 3"
   ```
   This will download the specified songs to the default directory (`$HOME/music`) in the default format (`mp3`).

3. Combining Both Methods:  
   To download both songs from the input file and songs provided directly on the command line:
   ```bash
   pamus -s "Song Name 1" "Song Name 2" -i /path/to/song_list.txt
   ```
   This will download the songs listed in `song_list.txt` as well as the songs provided directly via the command line.

4. With Additional Options:  
   To download songs from a specific list, save them to a custom directory, use a specific audio format, and enable verbose output:
   ```bash
   pamus -o /path/to/save/music -i /path/to/song_list.txt -f opus -v
   ```

### Example list.txt file (supports comments)
```txt
# Rock
Queen - Bohemian Rhapsody # One of the best
```