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.3.tar.gz (7.5 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.3-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lastfm-mpris2-scrobbler-1.0.3.tar.gz
Algorithm Hash digest
SHA256 6e8da9d2a51dda280d9aa3efe1dfce09c5da24f0508f97ab80a82b87dc5331c3
MD5 913e54a0691523f270661efcf559f002
BLAKE2b-256 05c49a68b35e8b490e0e98d7855796922e46194832412ed3b7f1e6fe3e46401d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lastfm_mpris2_scrobbler-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2be5b6068d50c5f5aa9c05d928115b4a0bfdf234ce1d07e3b50f278b10979375
MD5 17aff95f77c3a7983cec82d5ccbafb3c
BLAKE2b-256 320669aa619077033d97744f52400129620f0b449a8de1f216111a8780937c90

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