term-music 0.2.1
A music player for the terminal
Requires Python: >=3.7.0
Keywords: terminal,music,player,library,youtube-dl

# Term-Music 

**still in development**

Terminal music player with audio visualization and youtube-dl integration.

![](https://github.com/tracksuitdev/term-music/blob/master/assets/term-music.gif?raw=true)

## Installation

Install using pip `pip install term-music`. After installation, you can run `term-music`.

At first run, the program will create a folder called `.term-music` in your home directory with config.ini file with
default settings. You can change the settings in the config file to your liking. 

Also in the `.term-music` directory
there will be a `music-lib` folder where all your songs will be downloaded to. You can change this by changing the
`download_folder` setting in the config file.

## Usage

Inside your download folder all .mp3 files will be considered as songs and all .txt files will be considered as 
playlists.

Playlist files should be text files with each line containing the name of a song (without extension) that is in your library.


```
usage: music [-h] [-v] {play,playall,playlist,ls,load} ...

positional arguments:
  {play,playall,playlist,ls,load}
    play                play a song
    playall             play all songs or playlists
    playlist            play playlist
    ls                  list songs
    load                download a list of songs

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
```

### play

```
usage: music play [-h] [-e] [-nd] query [query ...]

positional arguments:
  query              query used to search the library or youtube for the song
                     to play

options:
  -h, --help         show this help message and exit
  -e, --exact        only use exact matches to play a song from library, will
                     not search youtube or download a song
  -nd, --nodownload  don't search youtube and download the song if none is
                     found in library

```

### playall

```
usage: music playall [-h] [{songs,playlists}]

positional arguments:
  {songs,playlists}

options:
  -h, --help         show this help message and exit
```

### playlist

```
usage: music playlist [-h] [-e] query

positional arguments:
  query        query used to search the library for a playlist to play

options:
  -h, --help   show this help message and exit
  -e, --exact  only play a playlist if exact match is found
```

### ls

```
usage: music ls [-h] [-a] [-p] [-f]

options:
  -h, --help      show this help message and exit
  -a, --all       list all songs and playlists
  -p, --playlist  list only playlists
  -f, --full      list all songs with playlists they are on
```

### load

```
usage: music load [-h] [-p PLAYLIST] [-c] songs [songs ...]

positional arguments:
  songs                 list of songs to download in music library

options:
  -h, --help            show this help message and exit
  -p PLAYLIST, --playlist PLAYLIST
                        name of the playlist that will be made out of
                        downloaded songs
  -c, --check           if true will check if song already exists and won't
                        download it
```