Python module and CLI for the LRCLIB API

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for iiPython from gravatar.com iiPython
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Requires: Python >=3.10
Classifiers
Report project as malware

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 download lyrics for a given folder:
lrcup autosearch /mnt/music/

# 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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for iiPython from gravatar.com iiPython
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Requires: Python >=3.10
Classifiers

Release history Release notifications | RSS feed

This version

0.9.2

0.9.0

0.9.0a0 pre-release

0.8.0

0.7.0

0.6.0

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.4

0.4.3

0.3.2

0.3

0.2

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

Uploaded Source

Built Distribution

lrcup-0.9.2-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lrcup-0.9.2.tar.gz
Algorithm Hash digest
SHA256 472c3527395119752ff7af454c0c0630cf1a6a5ac87fd638c303ca46a6759474
MD5 bb396d088e900d64062188386a46f36b
BLAKE2b-256 a89449291ee33f5b64a1fce2024e18d41b61ad5cee63c49ce3bb8eba1236be21

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: lrcup-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 10.3 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.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f029f81723368b1b1547f65a25bddd5983b25f6b5864ca82155f8573acfe8566
MD5 8968bbd7150bbd2655935ad027069b13
BLAKE2b-256 fc3b93417c5699e6cb5fcb49bfe2ccfd2c7f4d3cf9b00c4338550ac448180af9

See more details on using hashes here.

Provenance

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