**************
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>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/mopidy/mopidy-spotify",
"name": "Mopidy-Spotify",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Stein Magnus Jodal",
"author_email": "stein.magnus@jodal.no",
"download_url": "https://files.pythonhosted.org/packages/dc/9c/abd89195770fa8a7b7835f23b41657a0eddf13b58512a916da2dfd126d92/Mopidy-Spotify-4.1.1.tar.gz",
"platform": "",
"description": "**************\nMopidy-Spotify\n**************\n\n.. image:: https://img.shields.io/pypi/v/Mopidy-Spotify\n :target: https://pypi.org/project/Mopidy-Spotify/\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/github/workflow/status/mopidy/mopidy-spotify/CI\n :target: https://github.com/mopidy/mopidy-spotify/actions\n :alt: CI build status\n\n.. image:: https://img.shields.io/codecov/c/gh/mopidy/mopidy-spotify\n :target: https://codecov.io/gh/mopidy/mopidy-spotify\n :alt: Test coverage\n\n`Mopidy <https://mopidy.com/>`_ extension for playing music from\n`Spotify <https://www.spotify.com/>`_.\n\n\nStatus\n======\n\nMopidy-Spotify is dependent on ``pyspotify``, a wrapper for Spotify's\n``libspotify`` C library. ``libspotify`` was `deprecated in 2015\n<https://github.com/mopidy/mopidy-spotify/issues/110>`_ with no replacement. It\nis unmaintained, functionally limited, and also now unavailable from the\n`Spotify developer site <https://developer.spotify.com/technologies/>`_. Where\npossible we are `moving to use Spotify's Web API instead\n<https://github.com/mopidy/mopidy-spotify/issues/114>`_. However, native\nplayback is still only possible using ``libspotify`` and there is no official\nway for us to provide some Spotify features.\n\nLimitations and/or bugs in ``libspotify`` currently result in missing/broken\nMopidy-Spotify support for the following:\n\n- Saving items to My Music (`#108 <https://github.com/mopidy/mopidy-spotify/issues/108>`_) -\n possible via web API\n\n- Podcasts (`#201 <https://github.com/mopidy/mopidy-spotify/issues/201>`_) -\n unavailable\n\n- Radio (`#9 <https://github.com/mopidy/mopidy-spotify/issues/9>`_) - unavailable\n\n- Spotify Connect (`#14 <https://github.com/mopidy/mopidy-spotify/issues/14>`_) -\n unavailable\n\nWorking support for the following features is currently available:\n\n- Playback\n\n- Search\n\n- Playlists (read-only)\n\n- Top lists and Your Music (read-only)\n\n- Lookup by URI\n\n\nDependencies\n============\n\n- A Spotify Premium subscription. Mopidy-Spotify **will not** work with Spotify\n Free, just Spotify Premium.\n\n- A non-Facebook Spotify username and password. If you created your account\n through Facebook you'll need to create a \"device password\" to be able to use\n Mopidy-Spotify. Go to http://www.spotify.com/account/set-device-password/,\n login with your Facebook account, and follow the instructions. However,\n sometimes that process can fail for users with Facebook logins, in which case\n you can create an app-specific password on Facebook by going to facebook.com >\n Settings > Security > App passwords > Generate app passwords, and generate one\n to use with Mopidy-Spotify.\n\n- ``libspotify`` 12. The official C library from our `Unofficial\n libspotify archive <https://mopidy.github.io/libspotify-archive/>`_.\n The package is available as ``libspotify12`` from\n `apt.mopidy.com <http://apt.mopidy.com/>`__.\n\n- ``pyspotify`` >= 2.0.5. The ``libspotify`` Python wrapper. The package is\n available as ``python3-spotify`` from apt.mopidy.com or ``pyspotify`` on PyPI.\n See https://pyspotify.readthedocs.io/en/latest/installation/ for how to install\n it and its dependencies on most platforms.\n\n- ``Mopidy`` >= 3.0. The music server that Mopidy-Spotify extends.\n\nIf you install Mopidy-Spotify from apt.mopidy.com, AUR, or Homebrew, these\ndependencies are installed automatically.\n\n\nInstallation\n============\n\nInstall by running::\n\n sudo python3 -m pip install Mopidy-Spotify\n\nSee https://mopidy.com/ext/spotify/ for alternative installation methods.\n\n\nConfiguration\n=============\n\nBefore starting Mopidy, you must add your Spotify Premium username and password\nto your Mopidy configuration file and also visit\nhttps://mopidy.com/ext/spotify/#authentication\nto authorize this extension against your Spotify account::\n\n [spotify]\n username = alice\n password = secret\n client_id = ... client_id value you got from mopidy.com ...\n client_secret = ... client_secret value you got from mopidy.com ...\n\nThe following configuration values are available:\n\n- ``spotify/enabled``: If the Spotify extension should be enabled or not.\n Defaults to ``true``.\n\n- ``spotify/username``: Your Spotify Premium username. You *must* provide this.\n\n- ``spotify/password``: Your Spotify Premium password. You *must* provide this.\n\n- ``spotify/client_id``: Your Spotify application client id. You *must* provide this.\n\n- ``spotify/client_secret``: Your Spotify application secret key. You *must* provide this.\n\n- ``spotify/bitrate``: Audio bitrate in kbps. ``96``, ``160``, or ``320``.\n Defaults to ``160``.\n\n- ``spotify/volume_normalization``: Whether volume normalization is active or\n not. Defaults to ``true``.\n\n- ``spotify/timeout``: Seconds before giving up waiting for search results,\n etc. Defaults to ``10``.\n\n- ``spotify/allow_cache``: Whether to allow caching. The cache is stored in a\n \"spotify\" directory within Mopidy's ``core/cache_dir``. Defaults to ``true``.\n\n- ``spotify/allow_network``: Whether to allow network access or not. Defaults\n to ``true``.\n\n- ``spotify/allow_playlists``: Whether or not playlists should be exposed.\n Defaults to ``true``.\n\n- ``spotify/search_album_count``: Maximum number of albums returned in search\n results. Number between 0 and 50. Defaults to 20.\n\n- ``spotify/search_artist_count``: Maximum number of artists returned in search\n results. Number between 0 and 50. Defaults to 10.\n\n- ``spotify/search_track_count``: Maximum number of tracks returned in search\n results. Number between 0 and 50. Defaults to 50.\n\n- ``spotify/toplist_countries``: Comma separated list of two letter ISO country\n codes to get toplists for. Defaults to blank, which is interpreted as all\n countries that Spotify is available in.\n\n- ``spotify/private_session``: Whether to use a private Spotify session. Turn\n on private session to disable sharing of played tracks with friends through\n the Spotify activity feed, Last.fm scrobbling, and Facebook. This only\n affects social sharing done by Spotify, not by other Mopidy extensions.\n Defaults to ``false``.\n\n\nProject resources\n=================\n\n- `Source code <https://github.com/mopidy/mopidy-spotify>`_\n- `Issue tracker <https://github.com/mopidy/mopidy-spotify/issues>`_\n- `Changelog <https://github.com/mopidy/mopidy-spotify/releases>`_\n\n\nCredits\n=======\n\n- Original author: `Stein Magnus Jodal <https://github.com/jodal>`__\n- Current maintainer: `Stein Magnus Jodal <https://github.com/jodal>`__\n- `Contributors <https://github.com/mopidy/mopidy-spotify/graphs/contributors>`_\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Mopidy extension for playing music from Spotify",
"version": "4.1.1",
"project_urls": {
"Homepage": "https://github.com/mopidy/mopidy-spotify"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd8ecf9d116a69f5149b8555ca84a6ae518414f195e51daecc830a16e3e5cdb8",
"md5": "8146e8660fd44bab37bd23927a6be7ad",
"sha256": "e1da2fa518004954b110633590dd706b7d109a449a2e69c39f5c1841805bc0f9"
},
"downloads": -1,
"filename": "Mopidy_Spotify-4.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8146e8660fd44bab37bd23927a6be7ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 31276,
"upload_time": "2021-01-07T13:49:16",
"upload_time_iso_8601": "2021-01-07T13:49:16.181481Z",
"url": "https://files.pythonhosted.org/packages/fd/8e/cf9d116a69f5149b8555ca84a6ae518414f195e51daecc830a16e3e5cdb8/Mopidy_Spotify-4.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc9cabd89195770fa8a7b7835f23b41657a0eddf13b58512a916da2dfd126d92",
"md5": "abb8d410908bc3f07174614f8d0ea07e",
"sha256": "e137d0675288e48563c15d50cb2722c618f1a085673f96b620e64fafdaab97af"
},
"downloads": -1,
"filename": "Mopidy-Spotify-4.1.1.tar.gz",
"has_sig": false,
"md5_digest": "abb8d410908bc3f07174614f8d0ea07e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 49442,
"upload_time": "2021-01-07T13:49:17",
"upload_time_iso_8601": "2021-01-07T13:49:17.425073Z",
"url": "https://files.pythonhosted.org/packages/dc/9c/abd89195770fa8a7b7835f23b41657a0eddf13b58512a916da2dfd126d92/Mopidy-Spotify-4.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-01-07 13:49:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mopidy",
"github_project": "mopidy-spotify",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mopidy-spotify"
}
JSON
