mopidy-spotify 5.0.0a4__tar.gz

mopidy_spotify-5.0.0a4/.copier-answers.yml

@@ -0,0 +1,8 @@
+_commit: v2.1.1
+_src_path: gh:mopidy/mopidy-ext-template
+author_email: stein.magnus@jodal.no
+author_full_name: Stein Magnus Jodal
+dist_name: mopidy-spotify
+ext_name: spotify
+github_username: mopidy
+short_description: Mopidy extension for playing music from Spotify

mopidy_spotify-5.0.0a4/.github/ISSUE_TEMPLATE/issue-template.md

@@ -0,0 +1,10 @@
+---
+name: Streaming in the latest release (v4.1.1) and earlier is broken, see the pinned issue.
+about: Check known issues before submitting new bugs
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+If your bug is not related to #110, feel free to file a new bug.

mopidy_spotify-5.0.0a4/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: hynek/build-and-inspect-python-package@v2
+
+  main:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: "pytest (3.11)"
+            python: "3.11"
+            tox: "3.11"
+          - name: "pytest (3.12)"
+            python: "3.12"
+            tox: "3.12"
+          - name: "pytest (3.13)"
+            python: "3.13"
+            tox: "3.13"
+            coverage: true
+          - name: "pyright"
+            python: "3.13"
+            tox: "pyright"
+          - name: "ruff check"
+            python: "3.13"
+            tox: "ruff-check"
+          - name: "ruff format"
+            python: "3.13"
+            tox: "ruff-format"
+
+    name: ${{ matrix.name }}
+    runs-on: ubuntu-24.04
+    container: ghcr.io/mopidy/ci:latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Fix home dir permissions to enable pip caching
+        run: chown -R root /github/home
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+          allow-prereleases: true
+      - run: python -m pip install tox
+      - run: python -m tox -e ${{ matrix.tox }}
+        if: ${{ ! matrix.coverage }}
+      - run: python -m tox -e ${{ matrix.tox }} -- --cov-report=xml
+        if: ${{ matrix.coverage }}
+      - uses: codecov/codecov-action@v5
+        if: ${{ matrix.coverage }}
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

mopidy_spotify-5.0.0a4/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/project/mopidy-spotify/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: hynek/build-and-inspect-python-package@v2
+        id: build
+      - uses: actions/download-artifact@v4
+        with:
+          name: ${{ steps.build.outputs.artifact-name }}
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

mopidy_spotify-5.0.0a4/.gitignore

@@ -0,0 +1,9 @@
+*.egg-info/
+/*.lock
+/.*_cache/
+/.coverage
+/.tox/
+/.venv/
+/build/
+/dist/
+__pycache__/

mopidy_spotify-5.0.0a4/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mopidy_spotify-5.0.0a4/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.2
+Name: mopidy-spotify
+Version: 5.0.0a4
+Summary: Mopidy extension for playing music from Spotify
+Author-email: Stein Magnus Jodal <stein.magnus@jodal.no>
+Maintainer-email: Nick Steel <nick@nsteel.co.uk>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/mopidy/mopidy-spotify
+Classifier: Environment :: No Input/Output (Daemon)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mopidy>=4.0.0a4
+Requires-Dist: pykka>=4
+Requires-Dist: requests>=2.20.0
+
+# mopidy-spotify
+
+[![Latest PyPI version](https://img.shields.io/pypi/v/mopidy-spotify)](https://pypi.org/p/mopidy-spotify)
+[![CI build status](https://img.shields.io/github/actions/workflow/status/mopidy/mopidy-spotify/ci.yml)](https://github.com/mopidy/mopidy-spotify/actions/workflows/ci.yml)
+[![Test coverage](https://img.shields.io/codecov/c/gh/mopidy/mopidy-spotify)](https://codecov.io/gh/mopidy/mopidy-spotify)
+
+[Mopidy](https://mopidy.com/) extension for playing music from [Spotify](https://www.spotify.com/).
+
+## Status
+
+> [!WARNING]
+> Spotify have recently disabled username and password login for playback
+> ([#394](https://github.com/mopidy/mopidy-spotify/issues/394)) and we now use
+> access token login. You no longer need to provide your Spotify account
+> username or password.
+
+Mopidy-Spotify currently has no support for the following:
+
+- Seeking
+- Gapless playback
+- Volume normalization
+- 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)) -
+  now possible
+- Radio ([#9](https://github.com/mopidy/mopidy-spotify/issues/9)) - unavailable?
+- Spotify Connect ([#14](https://github.com/mopidy/mopidy-spotify/issues/14))
+
+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.
+
+- Mopidy >= 3.4. The music server that Mopidy-Spotify extends.
+
+- `gst-plugins-spotify`, the [GStreamer Rust Plugin]
+  (https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs) for Spotify
+  playback, based on [librespot](https://github.com/librespot-org/librespot/).
+  _This plugin is not yet available from apt.mopidy.com_. It must be either
+  [built from source]
+  (https://github.com/kingosticks/gst-plugins-rs-build/tree/main?tab=readme-ov-file#native-compile)
+  or [Debian packages are available]
+  (https://github.com/kingosticks/gst-plugins-rs-build/releases/latest)
+  for some platforms.
+
+**We currently require a forked version of this plugin which supports
+token-based login.** This can be found
+[here](https://gitlab.freedesktop.org/kingosticks/gst-plugins-rs/-/tree/spotify-access-token-logging).
+
+Verify the GStreamer spotify plugin is correctly installed:
+
+```sh
+gst-inspect-1.0 spotifyaudiosrc | grep Version | awk '{print $2}'
+```
+
+## Installation
+
+Install by running:
+
+```sh
+sudo python3 -m pip install --break-system-packages mopidy-spotify==5.0.0a3
+```
+
+## Configuration
+
+Before starting Mopidy, you must visit https://mopidy.com/ext/spotify/#authentication
+to authorize this extension against your Spotify account:
+
+```ini
+[spotify]
+client_id = ... client_id value you got from mopidy.com ...
+client_secret = ... client_secret value you got from mopidy.com ...
+```
+
+> [!IMPORTANT]
+> Remove any `credentials.json` file you may have manually created.
+
+The following configuration values are available:
+
+- `spotify/enabled`: If the Spotify extension should be enabled or not.
+  Defaults to `true`.
+
+- `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/cache_size`: Maximum cache size in MiB. Set to `0` for unlimited. Defaults to `8192`.
+
+- `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/username`: Deprecated since v5.0.0a3.
+
+- `spotify/password`: Deprecated since v5.0.0a3.
+
+## Project resources
+
+- [Source code](https://github.com/mopidy/mopidy-spotify)
+- [Issues](https://github.com/mopidy/mopidy-spotify/issues)
+- [Releases](https://github.com/mopidy/mopidy-spotify/releases)
+
+## Development
+
+### Set up development environment
+
+Clone the repo using, e.g. using [gh](https://cli.github.com/):
+
+```sh
+gh repo clone mopidy/mopidy-spotify
+```
+
+Enter the directory, and install dependencies using [uv](https://docs.astral.sh/uv/):
+
+```sh
+cd mopidy-spotify/
+uv sync
+```
+
+### Running tests
+
+To run all tests and linters in isolated environments, use
+[tox](https://tox.wiki/):
+
+```sh
+tox
+```
+
+To only run tests, use [pytest](https://pytest.org/):
+
+```sh
+pytest
+```
+
+To format the code, use [ruff](https://docs.astral.sh/ruff/):
+
+```sh
+ruff format .
+```
+
+To check for lints with ruff, run:
+
+```sh
+ruff check .
+```
+
+To check for type errors, use [pyright](https://microsoft.github.io/pyright/):
+
+```sh
+pyright .
+```
+
+### Making a release
+
+To make a release to PyPI, go to the project's [GitHub releases
+page](https://github.com/mopidy/mopidy-spotify/releases)
+and click the "Draft a new release" button.
+
+In the "choose a tag" dropdown, select the tag you want to release or create a
+new tag, e.g. `v0.1.0`. Add a title, e.g. `v0.1.0`, and a description of the changes.
+
+Decide if the release is a pre-release (alpha, beta, or release candidate) or
+should be marked as the latest release, and click "Publish release".
+
+Once the releease is created, the `release.yml` GitHub Action will automatically
+build and publish the release to
+[PyPI](https://pypi.org/project/mopidy-spotify/).
+
+## Credits
+
+- Original author: [Stein Magnus Jodal](https://github.com/mopidy)
+- Current maintainer: [Nick Steel](https://github.com/kingosticks)
+- [Contributors](https://github.com/mopidy/mopidy-spotify/graphs/contributors)