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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lrcup-0.10.1.tar.gz
Algorithm Hash digest
SHA256 69fcb813a64c4e86d215db86c224d229bb802fe29523f3e18b678a1880e95fcc
MD5 59766e614311e7eaeb83fbe03df14851
BLAKE2b-256 2e7164b73e13089c583743e593cde6c711596ea644b6930b7da84ff1a7f2cfd0

See more details on using hashes here.

Provenance

The following attestation bundles were made for lrcup-0.10.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: lrcup-0.10.1-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.12.9

File hashes

Hashes for lrcup-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd7eb7b0608a3b4585b4cbf90ffc8b7f098c6af9a0f732824b5866c2a483dc15
MD5 741fb70594bddd96fcd095d51b80dcef
BLAKE2b-256 dae68bc8708dd92d20c75635e58dc6a8909d7bc9853bd898ff38fd1d39117340

See more details on using hashes here.

Provenance

The following attestation bundles were made for lrcup-0.10.1-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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page