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

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.1.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.1-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lrclib_python-0.4.1.tar.gz
Algorithm Hash digest
SHA256 b3fb3300ade16d92e8dea3aac4f14f12d081b2391426f93680e7225b7db84365
MD5 ba57e8445cb3f8867da4db724e587e56
BLAKE2b-256 9f69f00894d63fb014c1935bb5731b2fd8b4cad9c3cde1b37063b4dd59d9fcbf

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for lrclib_python-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 09ac3a48fc4968811801cb7c6ce649aa23bab74018ff951a70491fc82f2d1ffa
MD5 600e8af6a796a150051610b3f25415af
BLAKE2b-256 80cda2d9438da53ee1408b93811e5eef7765afb49ac91b8c15ca438451852d31

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