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" = "playlist.txt"   # this file must exist on your machine
"download-directory-relative-path" = ".cache"    # this directory must exist on your machine
"audio-source-selection-on-import" = false       # it will download the first YouTube result as the audio file
"persistant-audio-cache" = true                  # it keeps audio and lyric files in cache after leaving the application
"music-lyrics-search-on-import" = false          # it will not download lyrics, nor use cached lyrics

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.

An example is for one line, the music name "etude op 10 number 4", the author "Frédéric Chopin", the tagged playlists "chopin" and "piano" that can be used as import #chopin or import #piano and the YouTube video source (https://www.youtube.com/watch?v=oy0IgI_qewg) that will be directly downloaded from:

etude op 10 no 4 by frédéric chopin #chopin #piano (https://www.youtube.com/watch?v=oy0IgI_qewg)

How to run the application

In the virtual environment with the dependencies in requirements.txt installed, 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, in the virtual environment with the dependencies in dev_requirements.txt installed, use in the project root directory:

pytest

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

pylint *

Build an executable

On Windows

To build the application executable, assuming that you have the dev_requirements.txt packages installed in your Python virtual environment, that you have that virtual environment is activated and that VLC is installed on your Windows OS at the C:\Program Files\VideoLAN\VLC location, run the PyInstaller from the repository directory with:

.\scripts\build.ps1

The executable's result is located in the dist\music-list-player directory.

To clean the reposity of the build artefacts, remove the builds from the repository directory with:

.\scripts\clean.ps1

Features

You can refer to the change log.

Backlog

• Add a music recommendation feature