Skip to main content

A simple ListenBrainz client library for Python

Project description

pylistenbrainz

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

pylistenbrainz 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 pylistenbrainz

client = pylistenbrainz.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 pylistenbrainz
import time

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

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

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

More detailed documentation is available at Read The Docs.

Features

pylistenbrainz 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 pylistenbrainz, take a look at the ListenBrainz API Documentation.

Installation

Install or upgrade pylistenbrainz with:

pip install pylistenbrainz --upgrade

Support

You can ask questions about how to use pylistenbrainz 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

pylistenbrainz - 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

pylistenbrainz-0.5.1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

pylistenbrainz-0.5.1-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file pylistenbrainz-0.5.1.tar.gz.

File metadata

  • Download URL: pylistenbrainz-0.5.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.10

File hashes

Hashes for pylistenbrainz-0.5.1.tar.gz
Algorithm Hash digest
SHA256 20f4649bad2e5d5e949ad0bf9238c4e632a8df0a0b2b2220bd055506fb95ab48
MD5 a78999e32cf0df4716a0397c4e44d530
BLAKE2b-256 e31124ca2dcec2be635728521610274088888fbf721e5cc0e2302d658fe8ebf2

See more details on using hashes here.

File details

Details for the file pylistenbrainz-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: pylistenbrainz-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.10

File hashes

Hashes for pylistenbrainz-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d56c281898f0ff3a75ade720a09fbfe56832e277fd0c2b5cc0949848c46dfc2
MD5 44f3cbbd39d58c6e556986561aa88d9a
BLAKE2b-256 17071af138c78dafcea3d1e5262b148cdf589593ff00cdf6db34effc69a89012

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