Skip to main content

A Python interface to Last.fm and Libre.fm

Project description

pyLast

PyPI version Supported Python versions Build status Coverage (Codecov) Coverage (Coveralls)

A Python interface to Last.fm and other API-compatible websites such as Libre.fm.

Use the pydoc utility for help on usage or see tests/ for examples.

Installation

Install via pip:

pip install pylast

Install latest development version:

pip install -U git+https://github.com/pylast/pylast.git

Or from requirements.txt:

-e git://github.com/pylast/pylast.git#egg=pylast

Note:

  • pyLast >= 2.2.0 supports Python 2.7.10+, 3.4, 3.5, 3.6, 3.7.
  • pyLast >= 2.0.0 < 2.2.0 supports Python 2.7.10+, 3.4, 3.5, 3.6.
  • pyLast >= 1.7.0 < 2.0.0 supports Python 2.7, 3.3, 3.4, 3.5, 3.6.
  • pyLast >= 1.0.0 < 1.7.0 supports Python 2.7, 3.3, 3.4.
  • pyLast >= 0.5 < 1.0.0 supports Python 2, 3.
  • pyLast < 0.5 supports Python 2.

Features

  • Simple public interface.
  • Access to all the data exposed by the Last.fm web services.
  • Scrobbling support.
  • Full object-oriented design.
  • Proxy support.
  • Internal caching support for some web services calls (disabled by default).
  • Support for other API-compatible networks like Libre.fm.
  • Python 3-friendly (Starting from 0.5).

Getting Started

Here's some simple code example to get you started. In order to create any object from pyLast, you need a Network object which represents a social music network that is Last.fm or any other API-compatible one. You can obtain a pre-configured one for Last.fm and use it as follows:

import pylast

# You have to have your own unique two values for API_KEY and API_SECRET
# Obtain yours from https://www.last.fm/api/account/create for Last.fm
API_KEY = "b25b959554ed76058ac220b7b2e0a026"  # this is a sample key
API_SECRET = "425b55975eed76058ac220b7b4e8a054"

# In order to perform a write operation you need to authenticate yourself
username = "your_user_name"
password_hash = pylast.md5("your_password")

network = pylast.LastFMNetwork(api_key=API_KEY, api_secret=API_SECRET,
                               username=username, password_hash=password_hash)

# Now you can use that object everywhere
artist = network.get_artist("System of a Down")
artist.shout("<3")


track = network.get_track("Iron Maiden", "The Nomad")
track.love()
track.add_tags(("awesome", "favorite"))

# Type help(pylast.LastFMNetwork) or help(pylast) in a Python interpreter
# to get more help about anything and see examples of how it works

More examples in hugovk/lastfm-tools and tests/.

Testing

The tests/ directory contains integration and unit tests with Last.fm, and plenty of code examples.

For integration tests you need a test account at Last.fm that will become cluttered with test data, and an API key and secret. Either copy example_test_pylast.yaml to test_pylast.yaml and fill out the credentials, or set them as environment variables like:

export PYLAST_USERNAME=TODO_ENTER_YOURS_HERE
export PYLAST_PASSWORD_HASH=TODO_ENTER_YOURS_HERE
export PYLAST_API_KEY=TODO_ENTER_YOURS_HERE
export PYLAST_API_SECRET=TODO_ENTER_YOURS_HERE

To run all unit and integration tests:

pip install pytest flaky mock
pytest

Or run just one test case:

pytest -k test_scrobble

To run with coverage:

pytest -v --cov pylast --cov-report term-missing
coverage report # for command-line report
coverage html   # for HTML report
open htmlcov/index.html

Project details


Release history Release notifications | RSS feed

This version

2.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pylast-2.2.0.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

pylast-2.2.0-py2.py3-none-any.whl (23.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pylast-2.2.0.tar.gz.

File metadata

  • Download URL: pylast-2.2.0.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pylast-2.2.0.tar.gz
Algorithm Hash digest
SHA256 a21a10e559cbb80db5eb72e20a22740496a292977ed3568c937560b8d6885ab4
MD5 00fa3bd21e6cab8f83243ec23c6286a1
BLAKE2b-256 8a1aece4ef4ebf51236ac25e9708fb3e1e70b6447e01262f8b156ccbda894fa9

See more details on using hashes here.

Provenance

File details

Details for the file pylast-2.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pylast-2.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 783291d967adf689a20b2190e604061121527a0375dee76ca344e80d6ea75e61
MD5 dc137cc86d60ccedd3e13d10eab109af
BLAKE2b-256 dfc6d20fb3c70c96ca0cbc631cc7105dee0321377ddaaf5542f5c57e06ae31be

See more details on using hashes here.

Provenance

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