Music list player

An audio player that uses text file to define your music playlist. It downloads audio files, plays musics, navigates through playlists and display song's lyrics.

The idea is to write your musics line by line in a simple plaintext file, so you can save your favorite songs anywhere.

How to use

How to install the application and the dependencies

The project uses Python 3.10 and it is not developped nor tested for earlier Python version.

Python libraries are listed in the requirements.txt files. To import the dependencies in a virtual environment, run:

• On Linux:

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
pip install -r requirements.txt

• On Windows:

py -m venv .venv
.venv\Scripts\activate
python -m pip install --upgrade pip
pip install -r requirements.txt

The python-vlc dependency requires the VLC software to be installed on your computer. Please use the latest version of VLC:

• On Linux, VLC version 3.0.16 works.
• On Windows, VLC version 3.0.20 works.

How to configure

For the configuration, use the configuration.toml file (must be located in this music-list-player directory) to specify your profiles (playlist file location, store audio files location and other settings). Use the provided configuration.toml file as a reference and feel free to modify it on your local repository. But do not remove fields from the [global-settings] part, they are mandatory for the global application settings.

A recommanded configuration is:

[my_profile]
"playlist-file-relative-path" = "playlists/my_playlist.txt" # must exist
"download-directory-relative-path" = "audios_downloads"     # must exist
"audio-source-selection-on-import" = false
"persistant-audio-cache" = true
"music-lyrics-search-on-import" = false 

For the playlist, the playlist file must be a list of the songs to play, with one song name per line (ending with a carriage return). Thanks to metadata parsing, you can add hashtags followed by a word to a line in order to tag the line. So in one profile you can import and play audios only with a specific tag you chose. In a way, it is like a tagged playlist inside your playlist.

How to run the application

In the virtual environment, run in the project root directory:

• On Linux:

.venv/bin/python main.py

• On Windows:

python main.py

When you have finished using the application, quit it and deactivate the virtual environment:

• On Linux and Windows:

deactivate

How to test

To run the tests, use in the project root directory:

pytest

To run the linter check, execute in the project root directory:

pylint *

Features

Implemented in version 1.0

• Command-line interface definition in-app
• Play audio
• Download musics from Internet
• Python virtual environment usage
• Shuffle the playlist order
• Audio is cached
• Autoplay at the end of music
• Stop and skip the music
• Show the name of the current and the upcoming songs and as a status
• Add some tests
• Check end of list when using "next" command
• Jump to another song in the playlist by name
• Loop toggle option to restart the playlist from the start at the end
• Change "pause" keyword to resume and its printing
• Handle age restricted youtube video

Implemented in version 1.1

• Support Windows
• Switch playlist profiles in app
• Erase cached when quitting the application as a setting
• Setup a continuous integration in GitHub with test on Linux platform
• Change volume
• Import the audios in background
• Print music's lyrics matching music's audio

Implemented

• Handle errors on not finding a Youtube video for the given names of the playlist
• Use a search function of a Python library
• Add a selection menu when downloading music from Youtube (with video name, channel name, video duration, views count, release date)
• Jump forward or backward in the current audio timeline
• Import automatically the playlist from configuration on application start
• Sanitize the audio's name with keywords and wildcard of filepath (like '/', '', or '*')
• Create playlist dynamically based on tag(s) present on each audio name (line)
• Check remaining disk usage when downloading audios
• Use directly a YouTube link if presents in the audio name (line)

Backlog

• Parse author part of the audio line in plain text file
• Speed up or down audios
• Add a resume mechanism to restart playlist on the song where the application did quit
• Provide an executable entry point file for Windows application per release
• Add colors to the prints and use a log system
• Add a music recommendation feature