Skip to main content

Python module and CLI for the LRCLIB API

Project description

LRCUP

Python CLI and library for interacting with the LRCLIB.net API.
Also includes tools for embedding lyrics, along with general LRC tools.

Installation

Install via PyPI:

pip install lrcup

CLI Usage

# Upload a synced/unsynced LRC file:
lrcup upload example.lrc

# Upload lyrics from an already embedded track:
lrcup upload file.flac

# Embed lyrics into a file:
lrcup embed lyrics.lrc track.flac

# Search for lyrics and download them:
lrcup search never gonna give you up

# Search and embed lyrics for a given folder:
lrcup autosearch --embed /mnt/music/

# Search and embed lyrics for a given folder, also save lrc files:
lrcup autosearch --embed --download /mnt/music/

Module Usage

The class method names are based off of the LRCLIB API endpoints.
Please refer to them for more information.

from lrcup import LRCLib

lrclib = LRCLib()

# Fetch synced lyrics via search
results = lrclib.search(
    track = "Never Gonna Give You Up",
    artist = "Rick Astley"
)
print(results[0].syncedLyrics)

# Fetch synced lyrics directly
track = lrclib.get(
    track = "Never Gonna Give You Up",
    artist = "Rick Astley",
    album = "Whenever You Need Somebody",
    duration = 215
)
if track is not None:
    print(track.syncedLyrics)

# Publish synced lyrics
lrclib.publish(
    token = lrclib.request_challenge(),
    track = "Never Gonna Give You Up",
    artist = "Rick Astley",
    album = "Whenever You Need Somebody",
    duration = 215,
    plain_lyrics = "*Rickrolling*",
    synced_lyrics = "[00:00.00] *Rickrolling*"
)

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

lrcup-0.10.2.tar.gz (25.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lrcup-0.10.2-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file lrcup-0.10.2.tar.gz.

File metadata

  • Download URL: lrcup-0.10.2.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lrcup-0.10.2.tar.gz
Algorithm Hash digest
SHA256 8e1b3418d5e9481cb262b09bdc910954523117fbbffd2e7b32a8b099e77977e5
MD5 e100959ca6efea2cdc2b5401c7a48a6a
BLAKE2b-256 e5a404cceeb38294727cadf46abc5f57c7fee0e60dc66f9c2058edd509394e41

See more details on using hashes here.

Provenance

The following attestation bundles were made for lrcup-0.10.2.tar.gz:

Publisher: publish.yml on iiPythonx/lrcup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lrcup-0.10.2-py3-none-any.whl.

File metadata

  • Download URL: lrcup-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lrcup-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e1fd2b8e7ae063975e368079d49175652f2235e313deb21d6731d68021a812ce
MD5 f5ea655c9bef49077cf00e98a8789759
BLAKE2b-256 b70d9328d5d65313fc983a6c74709c10ec5179f55b41a623453fb83accb69992

See more details on using hashes here.

Provenance

The following attestation bundles were made for lrcup-0.10.2-py3-none-any.whl:

Publisher: publish.yml on iiPythonx/lrcup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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