Skip to main content

Mopidy SQLite local library extension

Project description

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.

This extension also features experimental support for using album art embedded in local media files. 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 might still ignore album images provided by Mopidy-Local-SQLite.

Installation

Install 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:

[local]
library = sqlite

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

# hash algorithm used for generating local URIs and image file names
hash = md5

# 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

# set to "off" to disable enforcement of foreign key constraints
foreign_keys = on

# database connection timeout in seconds
timeout = 10

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

# directory where extracted images are stored; if relative, names a
# subdirectory of local/data_dir
image_dir = sqlite/images

# base URI for images; if blank, the local file URI will be used
image_base_uri = /sqlite/images/

# default extension for image files if the image type cannot be
# determined; leave blank to skip such images
default_image_extension =

Project Resources

Latest PyPI version Number of PyPI downloads

License

Copyright (c) 2014 Thomas Kemmer.

Licensed under the Apache License, Version 2.0.

Known Bugs and Limitations

The database schema does not support multiple artists, composers or performers for a single track or album (yet). Look out for “Ignoring multiple artists” warnings during a local scan to see if you are affected by this.

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

Mopidy-Local-SQLite-0.6.3.tar.gz (18.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page