mopidy-debugrel 0.1.0

Mopidy extension that provides a debugging Read-Eval loop over http

mopidy-debugrel

Mopidy extension that provides a Read-Eval loop over http, for debugging purpose.

Warning: enabling this extension leaves your server vulnerable, make sure mopidy is not exposed to the web when enabling it, and disable it when you are done.

TODO: add a enable_until configuration, to ensure

Installation

Install by running:

python3 -m pip install mopidy-debugrel

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

Configuration

This extension is disabled by default. To enable it, add the following to your mopidy configuration file:

[debugrel]
enabled = true

Usage

Overview

This extension exposes a single API endpoint, that will execute the python code that you pass in your request. For example:

import requests

MOPIDY_HOST = "localhost"
MOPIDY_PORT = "6680"

code = """
logger.info("hello")
"""

requests.post(f"http://{MOPIDY_HOST}:{MOPIDY_PORT}/debugrel/debug", json={"source": code})

Running this trigger the execution of code in mopidy, resulting in the following logs:

mopidy[1771]: INFO     2025-02-23 14:39:29,689 [1771:HttpServer] mopidy_debugrel
mopidy[1771]:   hello

In the context of execution, you can access mopidy config with self.config, and mopidy core with self.core

Examples

Some examples of code that you can use.

1. Access the backends

code = """
logger.info(self.core.backends.get())
"""

requests.post(f"http://{MOPIDY_HOST}:{MOPIDY_PORT}/debugrel/debug", json={"source": code})

Logs:

mopidy[1771]: INFO     2025-02-23 14:55:59,966 [1771:HttpServer] mopidy_debugrel
mopidy[1771]:   [<ActorProxy for FileBackend (urn:uuid:55234968-8840-4618-8bdb-f990c084fcac), attr_path=()>, <ActorProxy for M3UBackend (urn:uuid:eb60e9fe-5db9-4d8f-8444-d586aaae8573), attr_path=()>, <ActorProxy for StreamBackend (urn:uuid:1050cc10-6178-4820-aaf8-d4ab14cec939), attr_path=()>, <ActorProxy for BookmarksBackend (urn:uuid:ade7e4bd-2130-421e-9c98-aadeeaa77863), attr_path=()>, <ActorProxy for TidalBackend (urn:uuid:6cbdb63d-b5a5-4bc5-8ceb-7511457ac98a), attr_path=()>]

2. Instantiate a tidal backend

 code = """
 from mopidy_tidal.backend import TidalBackend
 backend = TidalBackend(self.config, None)
 logger.info(backend)
 """

 requests.post("http://gidouille.local:6680/debugrel/debug", json={"source": code})  ```

Logs:

mopidy[1771]: INFO     2025-02-23 14:54:53,030 [1771:HttpServer] mopidy_debugrel
mopidy[1771]:   TidalBackend (urn:uuid:b496ce6c-d856-4e37-939f-f311d067892d)

3. Print config entries:

 code = """
 for key, value in self.config.items():
     logger.info(f"{key}: {value}")
 """

 requests.post("http://gidouille.local:6680/debugrel/debug", json={"source": code})  ```

Project resources

• Source code
• Issues
• Releases

Development

Set up development environment

Clone the repo using, e.g. using gh:

gh repo clone sapristi/mopidy-debugrel

Enter the directory, and install dependencies using uv:

cd mopidy-debugrel/
uv sync

Setup before first release

Before the first release, you must enable trusted publishing on PyPI so that the release.yml GitHub Action can create the PyPI project and publish releases to PyPI.

When following the instructions linked above, use the following values in the form at PyPI:

• Publisher: GitHub
• PyPI project name: mopidy-debugrel
• Owner: sapristi
• Repository name: mopidy-debugrel
• Workflow name: release.yml
• Environment name: pypi (must match environment name in release.yml)

Making a release

To make a release to PyPI, go to the project's GitHub releases page 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.

Credits

• Original author: Mathias Millet
• Current maintainer: Mathias Millet
• Contributors