Update to mopidy-ext-template v2.2.0

.copier-answers.yml

@@ -0,0 +1,9 @@
+_commit: v2.2.0
+_src_path: gh:mopidy/mopidy-ext-template
+author_email: devel@sumpfralle.de
+author_full_name: Lars Kruse
+dist_name: mopidy-beets
+ext_name: beets
+github_username: mopidy
+short_description: Mopidy extension for playing music from a music collection managed
+    via Beets

.github/workflows/ci.yml

@@ -5,47 +5,57 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch:
 
 jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: hynek/build-and-inspect-python-package@v2
+
   main:
     strategy:
       fail-fast: false
       matrix:
         include:
-          - name: "Test: Python 3.9"
-            python: "3.9"
-            tox: py39
-          - name: "Test: Python 3.10"
-            python: "3.10"
-            tox: py310
-          - name: "Test: Python 3.11"
-            python: "3.11"
-            tox: py311
+          - name: "pytest (3.13)"
+            python: "3.13"
+            tox: "3.13"
+          - name: "pytest (3.14)"
+            python: "3.14"
+            tox: "3.14"
             coverage: true
-          - name: "Lint: check-manifest"
-            python: "3.11"
-            tox: check-manifest
-          - name: "Lint: flake8"
-            python: "3.11"
-            tox: flake8
+          # - name: "pyright"
+          #   python: "3.14"
+          #   tox: "pyright"
+          - name: "ruff check"
+            python: "3.14"
+            tox: "ruff-check"
+          - name: "ruff format"
+            python: "3.14"
+            tox: "ruff-format"
 
     name: ${{ matrix.name }}
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     container: ghcr.io/mopidy/ci:latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - name: Fix home dir permissions to enable pip caching
         run: chown -R root /github/home
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python }}
           cache: pip
-          cache-dependency-path: setup.cfg
-      - run: python -m pip install pygobject tox
+          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@v3
+      - uses: codecov/codecov-action@v5
         if: ${{ matrix.coverage }}
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release.yml

@@ -6,18 +6,18 @@ on:
 
 jobs:
   release:
-    runs-on: ubuntu-20.04
-
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/project/mopidy-beets/
+    permissions:
+      id-token: write
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-      with:
-        python-version: '3.9'
-    - name: "Install dependencies"
-      run: python3 -m pip install build
-    - name: "Build package"
-      run: python3 -m build
-    - uses: pypa/gh-action-pypi-publish@v1.13.0
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_TOKEN }}
+      - uses: actions/checkout@v6
+      - 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

.gitignore

@@ -1,10 +1,9 @@
-*.pyc
-/*.egg-info
+*.egg-info/
+/*.lock
+/.*_cache/
 /.coverage
-/.mypy_cache/
-/.pytest_cache/
 /.tox/
-/MANIFEST
+/.venv/
 /build/
 /dist/
-/docs/_build/
+__pycache__/

README.md

@@ -0,0 +1,166 @@
+# mopidy-beets
+
+[![Latest PyPI version](https://img.shields.io/pypi/v/mopidy-beets)](https://pypi.org/p/mopidy-beets)
+[![CI build status](https://img.shields.io/github/actions/workflow/status/mopidy/mopidy-beets/ci.yml)](https://github.com/mopidy/mopidy-beets/actions/workflows/ci.yml)
+[![Test coverage](https://img.shields.io/codecov/c/gh/mopidy/mopidy-beets)](https://codecov.io/gh/mopidy/mopidy-beets)
+
+[Mopidy](https://mopidy.com/) extension for playing music from a music collection managed via [Beets](https://beets.io/).
+This extension uses the
+[Beets plugin "web"](https://beets.readthedocs.io/en/latest/plugins/web.html).
+
+
+## Installation
+
+Install by running:
+
+```sh
+python3 -m pip install mopidy-beets
+```
+
+See https://mopidy.com/ext/beets/ for alternative installation methods.
+
+
+## Configuration
+
+1. Setup the [Beets plugin
+   "web"](https://beets.readthedocs.io/en/latest/plugins/web.html).
+
+2. Tell Mopidy where to find the Beets web interface by adding the following to
+   your `mopidy.conf`:
+
+   ```ini
+   [beets]
+   hostname = 127.0.0.1
+   port = 8337
+   ```
+
+3. Restart Mopidy.
+
+The Beets library is now accessible in the "browser" section of your Mopidy
+client. Additional searches in Mopidy return results from your Beets library.
+
+
+### Proxy configuration for OGG files (optional)
+
+In case you use a Beets version older than 1.6.1, you may need to configure
+an HTTP reverse-proxy server in front of the Beets web plugin (not Mopidy)
+because `it does not handle HTTP "Range" requests properly
+<https://github.com/beetbox/beets/pull/5057>`_.
+
+If you don't apply this workaround, Mopidy may not be able to stream/play
+large audio files and/or does not allow you to seek.
+The is the case for OGG files in particular.
+
+The following Nginx configuration snippet is sufficient:
+
+```
+server {
+    listen 127.0.0.1:8338;
+    root /usr/share/beets/beetsplug/web;
+    server_name beets.local;
+    location / {
+        proxy_pass http://localhost:8337;
+        # this statement forces Nginx to emulate "Range" responses
+        proxy_force_ranges on;
+        # Hide Range header from beets/flask, preventing range handling
+        proxy_set_header "Range" "";
+    }
+}
+```
+
+Now you should change the Mopidy configuration accordingly to point to the
+Nginx port above instead of the Beets port. Afterwards Mopidy will be able to
+play file formats that require seeking.
+
+
+## Usage
+
+1. Run `beet web` to start the Beets web interface.
+
+2. Start Mopidy and access your Beets library via any Mopidy client:
+
+   - Browse your collection by album
+   - Search for tracks or albums
+   - Let the music play!
+
+
+## Project resources
+
+- [Source code](https://github.com/mopidy/mopidy-beets)
+- [Issues](https://github.com/mopidy/mopidy-beets/issues)
+- [Releases](https://github.com/mopidy/mopidy-beets/releases)
+
+
+## Development
+
+### Set up development environment
+
+Clone the repo using, e.g. using [gh](https://cli.github.com/):
+
+```sh
+gh repo clone mopidy/mopidy-beets
+```
+
+Enter the directory, and install dependencies using [uv](https://docs.astral.sh/uv/):
+
+```sh
+cd mopidy-beets/
+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-beets/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 release is created, the `release.yml` GitHub Action will automatically
+build and publish the release to
+[PyPI](https://pypi.org/project/mopidy-beets/).
+
+
+## Credits
+
+- Original author: [Janez Troha](https://github.com/dz0ny)
+- Current maintainer: [Lars Kruse](https://github.com/sumpfralle)
+- [Contributors](https://github.com/mopidy/mopidy-beets/graphs/contributors)