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.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

syncedlyrics-1.0.0-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: syncedlyrics-1.0.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.5.0-1021-azure

File hashes

Hashes for syncedlyrics-1.0.0.tar.gz
Algorithm Hash digest
SHA256 26bc0847bb35b580324b77980ac9b1ce41c9cffed639eeeb9030017e1ba6b991
MD5 f952960cb07e27dd216294a5bf1d84b5
BLAKE2b-256 7b977dc3aa7cb356cea3264baee46e857272de008c80df0973cf9b29a8af9be5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for syncedlyrics-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44d16df2b40de84f80058621de785e1105d5eef6e95a09407af1c7d30b060fa9
MD5 898a3380511d03257a5f074f2754d832
BLAKE2b-256 6febeee5f7a84895486e1eaa3d73ec16d39b2103f85c7f1c4e70cda5fcb71c98

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