Skip to main content

Get an LRC format (synchronized) lyrics for your music with aiohttp support

Project description

syncedlyrics_aio

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

Downloads

Installation

pip install syncedlyrics_aio

Usage

CLI

syncedlyrics_aio "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.
-d The duration of track in ms. Keep default if unknow. Only for netease and tencent
-m Max deviation for lyrics in ms, ignore if duration is default

Python

import syncedlyrics_aio

loop = asyncio.get_event_loop()
lrc = loop.run_until_complete(syncedlyrics_aio.search("[TRACK_NAME] [ARTIST_NAME]"))
if lrc:
    print(lrc)

Or with options:

syncedlyrics_aio.search("...", plain_only=True, save_path="{search_term}_1234.lrc", providers=["NetEase"], duration=213000)

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_aio-1.0.2.tar.gz (15.1 kB view hashes)

Uploaded Source

Built Distribution

syncedlyrics_aio-1.0.2-py3-none-any.whl (20.8 kB view hashes)

Uploaded Python 3

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