Skip to main content

Get an LRC format (synchronized) lyrics for your music

Project description

syncedlyrics

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

Downloads

Installation

pip install syncedlyrics

Usage

CLI

syncedlyrics "SEARCH_TERM"

By default, this will prefer time synced lyrics, but use plaintext lyrics, if no synced lyrics are available. To only allow one type of lyrics specify --plain-only or --synced-only respectively.

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
--plain-only Only look for plain text (not synced) lyrics
--synced-only Only look for synced lyrics
--enhanced Searches for an Enhanced (word-level karaoke) format. If it isn't available, search for regular synced lyrics.

Python

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

# Or with options:
syncedlyrics.search("...", plain_only=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}},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

syncedlyrics-1.0.1.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

syncedlyrics-1.0.1-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file syncedlyrics-1.0.1.tar.gz.

File metadata

  • Download URL: syncedlyrics-1.0.1.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1024-azure

File hashes

Hashes for syncedlyrics-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3db32469ed5a6dd5d96bb4eb16df44ba749121529b462efe0eb8b3df790f66b0
MD5 42d0fcb22cd37e9d15c9c18d7208e9a6
BLAKE2b-256 f17d8b1d838a4c1a9fd9ed2dfd5296592e1090f935748cb3b4996e4efe531d5d

See more details on using hashes here.

File details

Details for the file syncedlyrics-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: syncedlyrics-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1024-azure

File hashes

Hashes for syncedlyrics-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31ca4322311b454f969e837c7350ecbef241f705f2122ea0183a2902a1a3791a
MD5 2bbde57ab30df1211e1547fcd8401f82
BLAKE2b-256 7fad62d2a1cd2a251ea2d43185f2b98badb8acf97a42278ce424ea8a97d8f911

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page