mopidy-marceline

Mopidy extension with stylish frontend for controlling playback and browsing

Installation

Install by running:

python3 -m pip install mopidy-marceline

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

Configuration

Before starting Mopidy, you must add configuration for mopidy-marceline to your Mopidy configuration file:

[marceline]
# TODO: Add example of extension config

Project resources

• Source code
• Issues
• Releases

Development

Set up development environment

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

gh repo clone ttoino/mopidy-marceline

Enter the directory, and install dependencies using uv:

cd mopidy-marceline/
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 .

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-marceline
• Owner: ttoino
• Repository name: mopidy-marceline
• 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: João Pereira
• Current maintainer: João Pereira
• Contributors