summaryrefslogtreecommitdiff
path: root/README.md
blob: 3c00cd2a8040268e189815d32ea946b3518dc7ab (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
# JAMOS - Jackson's Awesome Music Organizing Scripts

## Purpose
Personal script to when downloading music with youtube-dl, tagging the files (artist, album, and track info), and organizing them into named folders.

## Installation
Right now, the easiest thing to do is just use it from this repo.

## Usage
Output from using the "--help" option:
```
usage: jamos [-h] [-c cookiefile.txt] [-o output_directory] [-r jamos_failed_urls.txt] [https://music.youtube.com/playlist?list=1234]

Download songs from YouTube Music

positional arguments:
  https://music.youtube.com/playlist?list=1234
                        Playlist or Song URL to download.

optional arguments:
  -h, --help            show this help message and exit
  -c cookiefile.txt, --cookies cookiefile.txt
                        Cookie file to use.
  -o output_directory, --output output_directory
                        Output directory to use
  -r jamos_failed_urls.txt, --retryFile jamos_failed_urls.txt
                        Output directory to use

```

The most common usage (aka tldr) would probably be something like:
```
$ jamos "https://music.youtube.com/playlist/1234" -o "/home/jackson/Music"
```

## TODO
    - Installation
        - Add necessary files to install via pip
        - AUR?
    - Configuration
        - Config file in XDG directory
        - URL file in XDG directory
    - [Done] Command line parameters