🎼 lyricy

A command line lyrics utility tool which search and add lyrics to your offline songs.

Why lyricy ?

We can use spotDL/spotify-downloader to download our spotify playlist and songs along with album art and metadata. But it does not add the lyrics of the songs in song metadata. lyricy search for the lyrics of the song add to song metadata.

you can use Retro music player for android to listen the offline local songs with synced lyrics.

Features

Used as a Python package, Desktop application and mobile application (PWA)
Easy to add lyrics to your offline songs
Preview of lyrics
Synced lyrics with lrc time tags
Lyrics without lrc tags
Save lyrics as lrc file
Add your own lyrics or downloaded lyrics to songs

GUI

GUI is built with flet

CLI

Installation

Using pip

pip install lyricy

Windows user download this executable file

Usage: python -m lyricy [OPTIONS] COMMAND [ARGS]...

  A command line lyrics utility tool which search and add lyrics to your
  offline songs.

Options:
  --help  Show this message and exit.

Commands:
  add     Search and add lyrics to given TRACK.
  remove  Remove lyrics from given TRACK.
  search  Search for lyrics for given track or query
  show    Show the lyrics of TRACK if available.

Searching for lyrics using your queries
Searching for lyrics for your track
Adding lyrics
Remove lyrics
Changing lyrics provider
Show lyrics
Downloading lrc file
Add lrc file to song

Searching for lyrics using your queries

Usage: python -m lyricy search [OPTIONS]

  Search for lyrics for given track or query

Options:
  -t, --track PATH       file path of track
  -d, --disable-preview  Disable the preview
  -l, --only-lyrics      Show Lyrics Only (without LRC tag)
  -s, --save TEXT        Save file as .lrc
  -q, --query TEXT       search query of track name
  -p, --provider TEXT    Lyrics provider name [rc] or [mo]
  --help                 Show this message and exit.

lyricy search --query "jolly yo gymkanna"

Searching for lyrics for your track

Track must have album metadata title

lyricy search --track 'Imagine Dragons - Believer.mp3'

After searching it print list of lyrics, enter the index number lyrics to get the full lyrics

Adding lyrics

Adding lyrics to track metadata to get synced lyrics

Usage: python -m lyricy add [OPTIONS] TRACK

  Search and add lyrics to given TRACK.

  TRACK is the filepath of track.

Options:
  -q, --query TEXT       search for this query instead of track name
  -d, --disable-preview  Disable the preview
  --show                 Print the lyrics and ask for confirmation
  --lrc PATH             Lyrics file to add on track
  -p, --provider TEXT    Lyrics provider name [rc] or [mo]
  --help                 Show this message and exit.

lyricy add 'Imagine Dragons - Believer.mp3'

select the preferred lyrics for the song to add it

If track does not have metadata title or any other irrelevant name, use can use --query option to override this.

lyricy add 'some-track.mp3' --query "vikram title track"

Changing lyrics provider

By default the lyrics provider is is megalobiz, but you can use other provider is rclyricsband

rc for https://rclyricsband.com/
mo for https://www.megalobiz.com/

lyricy add 'some-track.mp3' --query "vikram title track" --provider rc

lyricy search --query "karka kark" --provider mo

Remove lyrics

Usage: lyricy remove [OPTIONS] TRACK

  Remove lyrics from given TRACK.

  TRACK is the filepath of track.

Options:
  --help  Show this message and exit.

lyricy remove 'Imagine Dragons - Believer.mp3'

Show lyrics

Usage: lyricy show [OPTIONS] TRACK

  Show the lyrics of TRACK if available.

  TRACK is the filepath of track.

Options:
  -l, --only-lyrics  Show Lyrics Only (without LRC tag)
  --help             Show this message and exit.

lyricy show 'Imagine Dragons - Believer.mp31

Downloading lrc file

lyricy search --query "new york" --save "new_york"

This search and ask for the prompt, select any song it will download and save as lrc file

Add lrc file to song

lyricy add track.mp3 --lrc track.lrc

It will add the lyrics to song metadata

Python Package

Install

Using pip

pip install lyricy

Simple Usage

>>> from lyricy import Lyricy

>>> l = Lyricy()
>>> results = l.search("karka karka")
>>> selected_lyrics = results[0]
>>> selected_lyrics.fetch()

>>> selected_lyrics.lyrics
>>> selected_lyrics.lyrics_without_lrc_tags

Saving and adding lyrics to track

>>> selected_lyrics.save("lyrics.lrc")
>>> selected_lyrics.add_to_track("path_to_track.mp3")

Using Other Providers

Default provider is https://www.megalobiz.com/, but you can use other provider is https://rclyricsband.com/.

>>> from lyricy import Lyricy, Providers

>>> l = Lyricy()
>>> results = l.search("vikram", provider=Providers.RCLYRICSBAND)
>>> selected_lyrics = results[0]
>>> selected_lyrics.fetch()

>>> selected_lyrics.lyrics
>>> selected_lyrics.lyrics_without_lrc_tags

Dev Setup

Clone repo
Install package requirements

pip install -r requirements

Install dev requiremnts

pip install black flake8 pytest

Linting

black
flake8 -v

Test

pytest -v

Lyrics Providers

Contributions

Contributions are Welcome. Feel free to report bugs in issue and fix some bugs by creating pull requests. Comments, Suggestions, Improvements and Enhancements are always welcome.

yogeshwaran01 / lyricy Goto Github PK

lyricy's Introduction