syncedlyrics

1.0.1 verified Fri May 01 auth: no python

A Python library and CLI tool to fetch synchronized lyrics in LRC format from multiple providers (Musixmatch, Deezer, Genius, Lrclib, NetEase). Version 1.0.1, supports Python >=3.8. Active development with monthly releases.

pip install syncedlyrics

Common errors

error AttributeError: 'NoneType' object has no attribute 'strip' ↓

cause A provider returned None for a lyrics segment, and the library tried to strip it.

fix

Upgrade to syncedlyrics >=0.7.0 which fixes this bug. Alternatively, ensure the search term is correct.

error ModuleNotFoundError: No module named 'syncedlyrics' ↓

cause The package is not installed.

fix

Run pip install syncedlyrics.

Warnings

breaking In v1.0.0, the default behavior changed: `allow_plain` parameter now defaults to `False` (previously `True`). Previously, if no synced lyrics were found, plain (unsynced) lyrics would be returned. Now you must explicitly set `allow_plain=True` to get plain lyrics. ↓

fix If you rely on plain lyrics falling back, update calls to include `allow_plain=True`.

breaking In v1.0.0, the search function now returns the best match from all providers instead of the first synced result. This may change the returned lyrics for songs with multiple matches. ↓

fix No action required unless you were dependent on the old ordering; use `providers` parameter to restrict providers if needed.

gotcha Musixmatch provider may return empty results or raise exceptions if API limits are hit. The library catches HTTP errors but may return None silently. ↓

fix Always check if the returned value is None before processing. Consider implementing retries with exponential backoff if you see frequent failures.

deprecated Python 3.7 support was dropped in v0.7.0. ↓

fix Upgrade Python to >=3.8.

Imports

search
wrong
```
import syncedlyrics
```
correct
```
from syncedlyrics import search
```
The main function is `search`. Importing the module directly and calling `syncedlyrics.search(...)` also works, but the idiomatic way is to import `search` directly.
LRCFile
```
from syncedlyrics import LRCFile
```
LRCFile is a dataclass for parsed LRC content. Available since v0.4.0.

Quickstart

Fetch synchronized lyrics for a song. Returns LRC-formatted string or None. For translations, use `lrc = search('...', lang='fr')`.

from syncedlyrics import search

lrc = search('Kiss Me Until My Lips Fall Off')
if lrc:
    print(lrc[:200])
else:
    print('No lyrics found')