Mopidy-Spotify

.. image:: https://img.shields.io/pypi/v/Mopidy-Spotify :target: https://pypi.org/project/Mopidy-Spotify/ :alt: Latest PyPI version

.. image:: https://img.shields.io/github/workflow/status/mopidy/mopidy-spotify/CI :target: https://github.com/mopidy/mopidy-spotify/actions :alt: CI build status

.. image:: https://img.shields.io/codecov/c/gh/mopidy/mopidy-spotify :target: https://codecov.io/gh/mopidy/mopidy-spotify :alt: Test coverage

Mopidy <https://mopidy.com/>_ extension for playing music from Spotify <https://www.spotify.com/>_.

Status

Mopidy-Spotify is dependent on pyspotify, a wrapper for Spotify's libspotify C library. libspotify was deprecated in 2015 <https://github.com/mopidy/mopidy-spotify/issues/110>_ with no replacement. It is unmaintained, functionally limited, and also now unavailable from the Spotify developer site <https://developer.spotify.com/technologies/>. Where possible we are moving to use Spotify's Web API instead <https://github.com/mopidy/mopidy-spotify/issues/114>. However, native playback is still only possible using libspotify and there is no official way for us to provide some Spotify features.

Limitations and/or bugs in libspotify currently result in missing/broken Mopidy-Spotify support for the following:

• Saving items to My Music (#108 <https://github.com/mopidy/mopidy-spotify/issues/108>_) - possible via web API

• Podcasts (#201 <https://github.com/mopidy/mopidy-spotify/issues/201>_) - unavailable

• Radio (#9 <https://github.com/mopidy/mopidy-spotify/issues/9>_) - unavailable

• Spotify Connect (#14 <https://github.com/mopidy/mopidy-spotify/issues/14>_) - unavailable

Working support for the following features is currently available:

• Playback

• Search

• Playlists (read-only)

• Top lists and Your Music (read-only)

• Lookup by URI

Dependencies

• A Spotify Premium subscription. Mopidy-Spotify will not work with Spotify Free, just Spotify Premium.

• A non-Facebook Spotify username and password. If you created your account through Facebook you'll need to create a "device password" to be able to use Mopidy-Spotify. Go to http://www.spotify.com/account/set-device-password/, login with your Facebook account, and follow the instructions. However, sometimes that process can fail for users with Facebook logins, in which case you can create an app-specific password on Facebook by going to facebook.com > Settings > Security > App passwords > Generate app passwords, and generate one to use with Mopidy-Spotify.

• libspotify 12. The official C library from our Unofficial libspotify archive <https://mopidy.github.io/libspotify-archive/>_. The package is available as libspotify12 from apt.mopidy.com <http://apt.mopidy.com/>__.

• pyspotify >= 2.0.5. The libspotify Python wrapper. The package is available as python3-spotify from apt.mopidy.com or pyspotify on PyPI. See https://pyspotify.readthedocs.io/en/latest/installation/ for how to install it and its dependencies on most platforms.

• Mopidy >= 3.0. The music server that Mopidy-Spotify extends.

If you install Mopidy-Spotify from apt.mopidy.com, AUR, or Homebrew, these dependencies are installed automatically.

Installation

Install by running::

sudo python3 -m pip install Mopidy-Spotify

See https://mopidy.com/ext/spotify/ for alternative installation methods.

Configuration

Before starting Mopidy, you must add your Spotify Premium username and password to your Mopidy configuration file and also visit https://mopidy.com/ext/spotify/#authentication to authorize this extension against your Spotify account::

[spotify]
username = alice
password = secret
client_id = ... client_id value you got from mopidy.com ...
client_secret = ... client_secret value you got from mopidy.com ...

The following configuration values are available:

• spotify/enabled: If the Spotify extension should be enabled or not. Defaults to true.

• spotify/username: Your Spotify Premium username. You must provide this.

• spotify/password: Your Spotify Premium password. You must provide this.

• spotify/client_id: Your Spotify application client id. You must provide this.

• spotify/client_secret: Your Spotify application secret key. You must provide this.

• spotify/bitrate: Audio bitrate in kbps. 96, 160, or 320. Defaults to 160.

• spotify/volume_normalization: Whether volume normalization is active or not. Defaults to true.

• spotify/timeout: Seconds before giving up waiting for search results, etc. Defaults to 10.

• spotify/allow_cache: Whether to allow caching. The cache is stored in a "spotify" directory within Mopidy's core/cache_dir. Defaults to true.

• spotify/allow_network: Whether to allow network access or not. Defaults to true.

• spotify/allow_playlists: Whether or not playlists should be exposed. Defaults to true.

• spotify/search_album_count: Maximum number of albums returned in search results. Number between 0 and 50. Defaults to 20.

• spotify/search_artist_count: Maximum number of artists returned in search results. Number between 0 and 50. Defaults to 10.

• spotify/search_track_count: Maximum number of tracks returned in search results. Number between 0 and 50. Defaults to 50.

• spotify/toplist_countries: Comma separated list of two letter ISO country codes to get toplists for. Defaults to blank, which is interpreted as all countries that Spotify is available in.

• spotify/private_session: Whether to use a private Spotify session. Turn on private session to disable sharing of played tracks with friends through the Spotify activity feed, Last.fm scrobbling, and Facebook. This only affects social sharing done by Spotify, not by other Mopidy extensions. Defaults to false.

Project resources

• Source code <https://github.com/mopidy/mopidy-spotify>_
• Issue tracker <https://github.com/mopidy/mopidy-spotify/issues>_
• Changelog <https://github.com/mopidy/mopidy-spotify/releases>_

Credits

• Original author: Stein Magnus Jodal <https://github.com/jodal>__
• Current maintainer: Stein Magnus Jodal <https://github.com/jodal>__
• Contributors <https://github.com/mopidy/mopidy-spotify/graphs/contributors>_