musixmatch-inofficial/README.md
2024-08-18 18:25:03 +02:00

2 KiB

musixmatch-inofficial

Current crates.io version License CI status

This is an inofficial client for the Musixmatch API that uses the key embedded in the Musixmatch Android app.

It allows you to obtain synchronized lyrics in different formats (LRC, DFXP, JSON) for almost any song.

The Musixmatch API used to require a free account on https://www.musixmatch.com to be used. However, as of 2024, this requirement was removed and the API can be used anonymously. The client still allows you to supply credentials if Musixmatch decides to close the API down again.

Song lyrics are copyrighted works (just like books, poems and the songs themselves).

Musixmatch does allow its users to obtains song lyrics for private use (e.g. to enrich their music collection). But it does not allow you to publish their lyrics or use them commercially.

You will get in trouble if you use this client to create a public lyrics site/app. If you want to use Musixmatch data for this purpose, you will have to give them money (see their commercial plans) and use their official API.

Development info

The test suite reads Musixmatch credentials from the MUSIXMATCH_EMAIL and MUSIXMATCH_PASSWORD environment variables.

To make local development easier, I have included dotenvy to read the credentials from an .env file. Copy the .env.example file in the root directory, rename it to .env and fill in your credentials.