Skip to main content

A simple ListenBrainz client library for Python

Project description

liblistenbrainz

liblistenbrainz is a simple Python library for the ListenBrainz Web API.

liblistenbrainz will help you start getting data from and submitting data to ListenBrainz very quickly.

Here's an example of getting the listening history of a ListenBrainz user::

import liblistenbrainz

client = liblistenbrainz.ListenBrainz()
listens = client.get_listens(username='iliekcomputers')
for listen in listens:
    print("Track name:", listen.track_name)
    print("Artist name:", listen.artist_name)

Here's another quick example of how to submit a listen to ListenBrainz::

import liblistenbrainz
import time

auth_token = input('Please enter your auth token: ')

listen = liblistenbrainz.Listen(
    track_name="Fade",
    artist_name="Kanye West",
    release_name="The Life of Pablo",
    listened_at=int(time.time()),
)

client = liblistenbrainz.ListenBrainz()
client.set_auth_token(auth_token)
response = client.submit_single_listen(listen)

More detailed documentation is available at Read The Docs.

Features

liblistenbrainz provides easy access to all ListenBrainz endpoints, handles ratelimits automatically and supports the ListenBrainz authorization flow.

For details on the API endpoints that can be used via liblistenbrainz, take a look at the ListenBrainz API Documentation.

Installation

Install or upgrade liblistenbrainz with:

pip install liblistenbrainz --upgrade

Support

You can ask questions about how to use liblistenbrainz on IRC (freenode #metabrainz). You can also email me at iliekcomputers [at] gmail [dot] com.

If you have found a bug or have a feature request, let me know by opening an issue (or a pull request).

License

liblistenbrainz - A simple client library for ListenBrainz
Copyright (C) 2020 Param Singh <iliekcomputers@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

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

liblistenbrainz-0.5.5.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

liblistenbrainz-0.5.5-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file liblistenbrainz-0.5.5.tar.gz.

File metadata

  • Download URL: liblistenbrainz-0.5.5.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for liblistenbrainz-0.5.5.tar.gz
Algorithm Hash digest
SHA256 56eb564d0b0dab1b1bf77c01ec95c255fee3d84d51744b31851f2772ac95f41c
MD5 5ddeeff69bbbac750a782e31fa69b8b3
BLAKE2b-256 0f4717ba7ad7a8e7c5b2b42d99fbf56c776ab41e1b9feb49e4e271436b2d5c13

See more details on using hashes here.

File details

Details for the file liblistenbrainz-0.5.5-py3-none-any.whl.

File metadata

File hashes

Hashes for liblistenbrainz-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6ffd5ed013c3a4b341a880136ccd5eb683e0a7a8983305f423aaf1b7adbad366
MD5 2bba2225c5b7b428d7eded566793cbde
BLAKE2b-256 7915d42d8f28f6f2e4059285d6440c6f6186e5b1b162df96bfff3a985e9804f1

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