Skip to content

moehmeni/syncedlyrics

Repository files navigation

syncedlyrics

Get an LRC format (synchronized) lyrics for your music.

Downloads

Installation

pip install syncedlyrics

Usage

CLI

syncedlyrics "SEARCH_TERM"

Available Options

Flag Description
-o Path to save .lrc lyrics, default="{search_term}.lrc"
-p Space-separated list of providers to include in searching
-l Language code of the translation (ISO 639-1 format)
-v Use this flag to show the logs
--allow-plain Return a plain text (not synced) lyrics if no LRC format was found
--enhanced Return an Enhanced (word-level karaoke) format

Python

# This simple
lrc = syncedlyrics.search("[TRACK_NAME] [ARTIST_NAME]")

# Or with options:
syncedlyrics.search("...", allow_plain_format=True, save_path="{search_term}_1234.lrc", providers=["NetEase"])

# Get a translation along with the original lyrics (separated by `\n`):
syncedlyrics.search("...", lang="de")

# Get a word-by-word (karaoke) synced-lyrics if available
syncedlyrics.search("...", enhanced=True)

Providers

Feel free to suggest more providers or make PRs to fix the broken ones.

License

MIT

Citation

If you use this library in your research, you can cite as follows:

@misc{syncedlyrics,
  author = {Momeni, Mohammad},
  title = {syncedlyrics},
  year = {2022},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/moehmeni/syncedlyrics}},
}