mopidy-api-explorer

Mopidy extension which lets you explore the JSON-RPC API.

Installation

Install by running:

python3 -m pip install mopidy-api-explorer

Usage

Once the extension is installed, Mopidy must be restarted to detect the extension. After restarting Mopidy, visit the following URL to explore the Mopidy JSON-RPC API:

http://localhost:6680/api_explorer/

Project resources

• Source code
• Issues
• Releases

Development

Set up development environment

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

gh repo clone mopidy/mopidy-api-explorer

Enter the directory, and install dependencies using uv:

cd mopidy-api-explorer/
uv sync

Running tests

To run all tests and linters in isolated environments, use tox:

tox

To only run tests, use pytest:

pytest

To format the code, use ruff:

ruff format .

To check for lints with ruff, run:

ruff check .

To check for type errors, use pyright:

pyright .

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 release is created, the release.yml GitHub Action will automatically build and publish the release to PyPI.

Credits

• Original author: Janes Troha
• Current maintainer: Matthew Gamble
• Contributors