Mopidy-Local-SQLite

Mopidy-Local-SQLite is a Mopidy local library extension that uses an SQLite database for keeping track of your local media. This extension lets you browse your music collection by album, artist, composer and performer, and provides full-text search capabilities based on SQLite's FTS modules. It also notices updates via mopidy local scan while Mopidy is running, so you can scan your media library periodically from a cron job, for example.

Using album art embedded in local media files is also supported. If extract_images is set to true, images will be extracted from media files and stored seperately in Mopidy's local/data_dir. Corresponding image URIs will be provided for albums, so Web clients can access these images through Mopidy's integrated Web server. Note, however, that some clients will still ignore album images provided by Mopidy-Local-SQLite.

Installation

Mopidy-Local-SQLite can be installed using pip by running:

pip install Mopidy-Local-SQLite

Configuration

Before starting Mopidy, you must change your configuration to switch to using Mopidy-Local-SQLite as your preferred local library. It is also recommended to change the default scan_flush_threshold, to improve database access during a local scan:

[local]
library = sqlite
scan_flush_threshold = 100

Once this has been set you need to re-scan your library to populate the database:

mopidy local scan

This extension also provides some configuration settings of its own, but beware that these are still subject to change:

[local-sqlite]
enabled = true

# top-level directories for browsing, as <name> <uri>
directories =
    Albums              local:directory?type=album
    Artists             local:directory?type=artist
    Composers           local:directory?type=artist&role=composer
    Folders             local:directory:
    Genres              local:directory?type=genre
    Performers          local:directory?type=artist&role=performer
    Release Years       local:directory?type=date&format=%25Y
    Tracks              local:directory?type=track

# database connection timeout in seconds
timeout = 10

# whether to use an album's musicbrainz_id for generating its URI
use_album_mbid_uri = true

# whether to use an artist's musicbrainz_id for generating its URI;
# disabled by default, since some taggers do not handle this well for
# multi-artist tracks [https://github.com/sampsyo/beets/issues/907]
use_artist_mbid_uri = false

# whether to extract images from local media files
extract_images = false

# directory where local image files are stored; if not set, defaults
# to a private subdirectory of local/data_dir
image_dir =

# base URI for images; change this if you want to serve images using
# an alternative Web server, such as Apache or nginx
image_base_uri = /sqlite/images/

# list of file names to check for when searching for external album
# art; may contain UNIX shell patterns, i.e. "*", "?", etc.
album_art_files = *.jpg, *.jpeg, *.png

Project Resources

License

Licensed under the Apache License, Version 2.0.

Known Bugs and Limitations