Install the plugin into your local environment with:
pip install beets-ibroadcast
Enable the plugin by adding
plugins:section in your beets config file.
Configure your iBroadcast credentials:
ibroadcast: username: <your email address> password: <your password>
Be sure to put quotes around your password if it includes any special characters.
beet ibroadcast <query>
- All tracks matching the query are uploaded as needed.
- Usertags are synced with the tags on iBroadcast.
- Playlists are synced as playlists on iBroadcast, as long as the tracks of the playlist are all covered by the given query.
You don't. But it tries to be careful and guards against many edge cases.
If you want to see what the plugin will do without actually doing it, you can
-p (for "pretend") flag:
beet ibroadcast -p
I recommend starting with a small query, to get a feel for how it works. E.g.:
beet ibroadcast -p artist:Offspring album:Americana
If you like what you see, do it again without
-p and see how it goes.
Once you have some confidence in the tool, you can go nuts with larger queries.
When a track is uploaded, the plugin attaches
flexible attributes to the track. The next time that track is considered for
upload, these attributes are examined: if the track's
mtime is older than its
ib_uploadtime, the track is assumed to be up to date, and the upload is
For tracks where
mtime is newer, the track is uploaded again, and the
previous track ID is trashed. As such, obsolete previous versions of tracks
will appear in your iBroadcast trash until it is emptied.
Regardless: before uploading, the track's MD5 checksum is computed, and if the server already has a track with that checksum, the upload is skipped. As such, if you upload tracks with a different uploader than beets-ibroadcast, they will still be skipped (although as of this writing, beets-ibroadcast will read such files to compute their checksums every time they match a query, which will impact performance).
You can use the
-f flag to skip these checks and force reupload of tracks.
This plugin syncs tags on the iBroadcast side with the
attribute, in a way compatible with the usertag plugin.
If you modify a track's tags locally (e.g. via
beet addtag), those changes
will be synced to iBroadcast. If you modify a track's tags remotely (e.g. via
the iBroadcast website), those changes will be synced to the beets database.
In order to know whether a track's tags were changed locally, remotely, or
both since the last sync, the current state of the tags is stored in an
ib_tagids flexible attribute upon each successful sync. This strategy makes
it clear whether, for example, a tag that exists remotely but not locally was
deleted locally versus added remotely; as such, there cannot be tag conflicts.
See the usertag plugin documentation for details on working with tags in your beets database.
The plugin syncs playlists on the iBroadcast side with M3U playlist files stored locally in your playlists directory, as configured by the playlist plugin.
If you modify a playlist locally (e.g. by editing an M3U file), those changes will be synced to iBroadcast. If you modify a playlist remotely (e.g. via the iBroadcast website), those changes will be noticed, but not acted upon; instead, a message will be printed that the plugin is not smart enough to update your corresponding M3U file yet. PRs welcome to implement this feature! If a playlist has been modified both locally and remotely, the plugin will report the situation, but take no action.
In order to know whether a playlist's tracks were changed locally, remotely,
or both since the last sync, the playlist's current state is stored in a hidden
.ibroadcast-playlists.json in the base directory of your beets library.
See the playlist plugin documentation for details on working with playlists in your beets library.
One gotcha with playlist syncing is that playlists can only be synced from local to remote when the query you pass to the plugin matches all tracks of a playlist. So one simple way to sync all your playlists is to upload your entire beets library, by passing an empty query:
What if you don't want to upload your entire beets library to iBroadcast, though, but you still want to upload all tracks that are part of a playlist? Here is one way to accomplish that:
cat /path/to/playlists/*.m3u | sort -u > /tmp/tracks-to-upload.m3u beet ibroadcast playlist:/tmp/tracks-to-upload.m3u rm /tmp/tracks-to-upload.m3u
This will merge all the playlists in
/path/to/playlists/*.m3u into a single
temporary playlist file, which you then feed as your beets query; the
ibroadcast plugin will then ensure all tracks matching the query are uploaded,
and all playlists including those tracks are synced. This trick assumes that
you have configured the playlist directory in your beets config as follows:
playlist: playlist_dir: /path/to/playlists
Otherwise, the ibroadcast plugin can't find and sync your M3U files.
You can tell beets to be more verbose in its output using the
-v flag. E.g.:
beet -v ibroadcast usertags:favorites
This will cause the ibroadcast plugin to emit more detailed debugging messages.