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 autoembed /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.5.2.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

lrcup-0.5.2-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lrcup-0.5.2.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for lrcup-0.5.2.tar.gz
Algorithm Hash digest
SHA256 b3b030d7b76f99352a071c7ea7a38f0370b6c54e5d27bfe31a537ff2cafeb8fe
MD5 dc66a7aaccc4b134e0ccb3d3a805a936
BLAKE2b-256 61a2044f5d7b29915f6ea3e6f104b13194de872e5598dca1ccef62b46f2873f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lrcup-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for lrcup-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 55d2ad0f80858d6616f8b02af6f7d39ae84f299ef4dc8152b846524f2d154281
MD5 c81e7d06bec1ff02a96ef77a2a8364dd
BLAKE2b-256 c91de80fe3ccd629f2a818cdd54911a841c543954540c07b64d9a967e8615072

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