Skip to main content

Last.fm scrobbler via MPRIS2 in Linux

Project description

🎵 Last.fm scrobbler

A Last.fm scrobbler via MPRIS2 in Linux, implemented via pylast and mpris2

Modified based on dbus-scrobbler

Features

  • scrobble music to Last.fm if one of the conditions are met:

    • played for 4 mins
    • played for half the length
  • update now playing status

  • offline scrobble cache support

What is MPRIS2?

MPRIS (Media Player Remote Interfacing Specification) is a standard D-Bus (Desktop Bus) interface that allows applications to communicate with and control media players running on a Linux desktop environment.

Thus, this scrobbler is a general-purpose one under the Linux desktop environment, supporting scrobble music from media players without a built-in Last.fm scrobbling feature.

Check if your media player supports MPRIS2 via (make sure the player is running):

lastfm-mpris2-scrobbler --list-players

The uri names of players will be shown

Installation

There're two options available now:

  • grab the stand-alone binary from release page

  • or, via PyPI

    pip install lastfm-mpris2-scrobbler
    

Configurations

The program expects a config.yaml file and can be placed wherever you like, for example ~/.config/lastfm-mpris2-scrobbler/

Example and detailed information can be found in config.yaml.example:

# username for that service
user_name: foo

# md5 hash of your password (obtained via `echo -n password | md5sum`)
password_hash: abc123492abccf4f1997f7ccaabc123b

# last.fm api, which can be created via https://www.last.fm/api/account/create
api_key: 11111111111111111111111111111111
api_secret: 11111111111111111111111111111111

# the app's uri you want to scrobble
# use `lastfm-mpris2-scrobbler --list-players` to check the uri name
application_whitelist: [ "org.mpris.MediaPlayer2.harmonoid" ]

# app's log level
log_level: DEBUG

Usage

lastfm-mpris2-scrobbler -c PATH_TO_YOUR_CONFIG/config.yaml

For more options, see:

lastfm-mpris2-scrobbler --help

If you want to run it as a daemon service, here's a systemd service in user space for reference:

[Unit]
Description=Last.fm scrobbler via MPRIS2
Documentation=https://github.com/Ladbaby/lastfm-scrobbler

[Service]
ExecStart=PATH_TO_YOUR_BIN/lastfm-mpris2-scrobbler -c PATH_TO_YOUR_CONFIG/config.yaml

[Install]
WantedBy=default.target

You'll have to place the service file under ~/.config/systemd/user/ and name it like scrobbler.service

To run the daemon:

systemctl --user start scrobbler.service

To run at user login:

systemctl --user enable scrobbler.service

Alternatives

If you'd like a scrobbler similar to this, there're some choices. I recommand taking a look at scrobblez. It additionally provides Spotify related improvement, but doesn't provide stand-alone binary build for installation.

Also, although rescrobbled may also work, in my case it raised "Dbus error: argument type mismatch".

Known Issues

  • If the music title contains unwanted substring (like .mp3), then Last.fm won't accept the scrobble

    The program can now remove some of the unwanted substrings, including:

    • .mp3
    • .ogg
    • .wav
    • .acc
    • .flac

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

lastfm-mpris2-scrobbler-1.0.1.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lastfm_mpris2_scrobbler-1.0.1-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file lastfm-mpris2-scrobbler-1.0.1.tar.gz.

File metadata

  • Download URL: lastfm-mpris2-scrobbler-1.0.1.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for lastfm-mpris2-scrobbler-1.0.1.tar.gz
Algorithm Hash digest
SHA256 580c6dd898b3c63a2ffd204162da760fe94aeefb064e5ceef9344bbae04714f7
MD5 4edadf268eb9090b8d9d40a664e01b71
BLAKE2b-256 47d6d29b732bea9ed5e86c4ed425b2b925fc023141a102a36befcd712fc0bb05

See more details on using hashes here.

File details

Details for the file lastfm_mpris2_scrobbler-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for lastfm_mpris2_scrobbler-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b2590ac19476f9a032173bf6002b5a43439c1e554e41636a1f926324214dd85b
MD5 82872d073e344647e9964875d7b69793
BLAKE2b-256 fa2940e2009b9c6d7469ed2b1022cd4670baeeaf695ab2e446284526ca626cfa

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