Last.fm API for retrieving scrobbling data.
Project description
LastFmGet
LastFmGet is a Python package for accessing Last.fm scrobble data using the public API.
- Provides functions for calling specific Last.fm API methods
- Must use a cfg YAML file and call lastfmget.init() before any API calls
- Gets a response from the API in JSON and returns a Python dictionary
- Examples of the response for each method shown in test/dump
- Use _raw method verions for more direct access to the Last.fm API
Installation
pip install lastfmget
Dependencies
- Python3
- requests
- requests_cache (used only if configured in api_cfg.yaml)
- pyyaml
Documentation
lastfmget
Usage
Import
import lastfmget
Config
lastfmget.init('api_cfg.yaml')
api_cfg.yaml example (data/example_api_cfg.yaml)
api_url: http://ws.audioscrobbler.com/2.0/
api_key: <API KEY>
user_agent: <USER AGENT>
call_rate: 5 # Calls per second
cache:
enable: true
dir: .cache
backend: sqlite
lifetime: 120 # Seconds
# or (defaults)
cache:
enable: true
# or (disable)
cache:
enable: false
Field | Description |
---|---|
api_url | API root URL, should be 'http://ws.audioscrobbler.com/2.0/' |
api_key | Your private API key. See here |
user_agent | Identifiable user agent for requests |
call_rate | Max API requests per second |
cache | enable: use requests_cache dir: (optional) cache location backend: (optional) sqlite recommended lifetime: (optional) expire_after time in seconds |
Code Examples
Getting user information using the user.getInfo method
>>> info = lastfmget.user_info('D3r3k523')
>>> info['playcount']
161602
>>> info['user']['url']
'https://www.last.fm/user/D3r3k523'
Getting a user's top 10 artists using the user.getTopArtists method
>>> topartists = lastfmget.user_top_artists('D3r3k523', 10)
>>> [ artist['name'] for artist in topartists ]
['Radiohead', 'Converge', 'Pink Floyd', 'Queens of the Stone Age', 'Thee Oh Sees', 'Bon Iver', 'Tame Impala', 'Arcade Fire', 'Beach House', 'Mastodon']
Example Projects
Last.fm API Methods Available
Function | Last.fm API method |
---|---|
lastfmget.user_info | user.getInfo |
lastfmget.user_recent_tracks | user.getRecentTracks |
lastfmget.user_top_artists | user.getTopArtists |
lastfmget.user_top_albums | user.getTopAlbums |
lastfmget.user_top_tracks | user.getTopTracks |
lastfmget.user_weekly_chart_list | user.getWeeklyChartList |
lastfmget.user_weekly_artist_chart | user.getWeeklyArtistChart |
lastfmget.user_weekly_album_chart | user.getWeeklyAlbumChart |
lastfmget.user_weekly_track_chart | user.getWeeklyTrackChart |
Last.fm API Reference
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
lastfmget-1.0.0.tar.gz
(7.9 kB
view hashes)
Built Distribution
Close
Hashes for lastfmget-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3195473e9995a2cd7ab9dc468f44da07967f6ae45250f0f75072c0858c5ece41 |
|
MD5 | 937a92e8d61eb710222b5784546a27be |
|
BLAKE2b-256 | 0f5fc14c7e38c8eaa760f63766d0404acbed0b4d9f0dc04f3cd83b972d167a29 |