Skip to main content

A pure python client for lrclib

Project description

lrclib-python

An extremely basic wrapper for the lrclib api, a lightweight alternative to lrclibapi

Quickstart

First thing you have to do before anything is initiate the client

client = LrclibClient()

Basic usage:

# Get by id
s = client.get(3657360)

# Get by song signature (title, artist, album, duration)
s = client.get("Never Gonna Give You Up", "Rick Astley", duration = 213)
print(s.song_id) # song's id on lrclib
print(s.status) # can be one of three: "Synced", "Plain", "Instrumental"
print(s.synced_lyrics) # get the synced lyrics
print(s.plain_lyrics) # get the plain lyrics

# get a list of matching songs (title/query, artist, album)
results = client.search("Blur", "Stellar")
print(results[0]) # print the first result
# this can be used in the same way as s was in explaining the .get() method

extra docs at [/docs/quickstart.md]

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

lrclib_python-0.4.2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

lrclib_python-0.4.2-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file lrclib_python-0.4.2.tar.gz.

File metadata

  • Download URL: lrclib_python-0.4.2.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for lrclib_python-0.4.2.tar.gz
Algorithm Hash digest
SHA256 91a225a52dc5582c1f24a0c5efa9e14e5f81b4b42bbf5414dabfebb6a800a76f
MD5 722486586b7ae59950c99d0540243805
BLAKE2b-256 e827ed017a143b3acf697d1b304da5265dd9358eb7a975e803656d045846bfa5

See more details on using hashes here.

File details

Details for the file lrclib_python-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: lrclib_python-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for lrclib_python-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2699c94960a46f63fc753dc16cb12633b3a951a0ab8030a7015f2a974d98fc04
MD5 490ea019cd54622fd10e378014bd5a71
BLAKE2b-256 01d7f62793dfcb1a1ea48fad18c807c66e1d3917f4cdc91be348e29ca9a38a1e

See more details on using hashes here.

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