Skip to content

A program to upload playlists to Listenbrainz and give feedback in bulk

License

Notifications You must be signed in to change notification settings

Serene-Arc/listenbrainz-playlist-uploader

Repository files navigation

Listenbrainz Playlist Uploader

This is a helpful tool to upload all of your M3U playlists to Listenbrainz, the open source music scrobbler and history keeper. It also provides the ability to leave feedback on the songs in those playlists.

Tags are automatically read from the linked files and then matched with an ID through the Listenbrainz service. As such, the files in the playlist must have readable tags to work.

The token for the Listenbrainz account is required, and must be placed in a config.toml file under the key user_token. See the example configuration file for details.

It is highly recommended to have ffprobe installed and to use either beets or Picard to tag the files. This makes sure the artist and title are the same as in the MusicBrainz database and writes the MusicBrainz ID (MBID) to the file. ffprobe is then used to try to find any MBIDs embedded in the metadata, which allows for much more accurate and faster matching. It is part of ffmpeg and can be installed here. It is highly recommended to use this workflow, since otherwise the program will try to match based on the artist and title tags, which may not work or result in the wrong MBID being selected for a file.

Usage: listenbrainz-playlist-uploader [OPTIONS] <FILE> <PLAYLIST_NAME>

Arguments:

  • <FILE>
  • <PLAYLIST_NAME>

Options:

  • -c, --config <CONFIG>
    • Default value: ./config.toml
  • -f, --feedback <FEEDBACK>
    • Possible values: love, hate, neutral
    • Feedback is applied to all songs in the playlist.
    • If not supplied, feedback is not changed.
  • -p, --public
    • Default value: false
    • Possible values: true, false
    • Determines whether the playlist will be publicly visible or not.
  • -v, --verbose — Increase logging verbosity
  • -q, --quiet — Decrease logging verbosity
  • -d, --duplicate-action <DUPLICATE_ACTION>
    • Default value: none
    • Possible values: none, overwrite, number, abort
    • What to do when there is already a playlist by the same name on your account.
      • If you choose, number, a number will be appended to the end of the playlist name.
      • If you choose none, two playlists will have the same name but separate IDs.
  • -n, --no-confirm
    • Default value: false
    • Possible values: true, false
    • Disables any interaction in the program.

Things to Do

  • Read the Listenbrainz rate limiting dynamically to be more efficient.
  • Add pagination for playlist finding.

This document was partially generated automatically by clap-markdown.