README.md

Lyri

HTTP music dashboard to control playback via playerctl and display lyrics.

Description

Provides a Sanic web application and helper class to manage playback via playerctl.

The web application is hosted using Sanic, which provides endpoints to query player information from playerctl via PyGObject bindings. Lyrics are fetched using syncedlyrics.

Player information is pushed to the client over a WebSocket.

No external JavaScript libraries are requried.

Example

Installation

PyPI

1. Install project: pip install lyri
2. Run: lyri

Source

Alternatively, after cloning the repository with: git clone https://github.com/Zedeldi/lyri.git

Build

1. Install project: pip install .
2. Run: lyri or sanic lyri.server -H <host> -p <port>

Development

1. Install dependencies: pip install -r requirements.txt
2. Run: python -m lyri or sanic lyri.server --dev -H <host> -p <port>

Libraries

• PyGObject - GObject bindings
• Sanic - web framework and server
• syncedlyrics - lyrics fetcher

Credits

• Bootstrap Icons - icons
• Google Fonts - fonts

License

lyri is licensed under the MIT Licence for everyone to use, modify and share freely.

This project is distributed in the hope that it will be useful, but without any warranty.

Donate

If you found this project useful, please consider donating. Any amount is greatly appreciated! Thank you 😃