Skip to main content

lyriks License PyPI version PyPI downloads

A command line tool that fetches lyrics from Genie.

Installation

You can easily install lyriks from PyPI by using pip:

pip install lyriks

To install it from source instead, clone the repository and build the wheel before installing it with pip:

python -m build --wheel
pip install dist/lyriks-0.3.5-py3-none-any.whl

You can also run the script directly from within the repository:

`./lyriks.py /path/to/music/folder`

Make sure to first install the required dependencies from pyproject.toml.

Usage

Simply run the script with the path to the folder containing your music as an argument. This can be your whole collection, a single artist, or a single album.

lyriks /path/to/music/folder

The script will search for audio files (.flac or .mp3) in the given folder, and attempt to fetch the lyrics. Note that it will only be able to do that for files that are properly tagged with MusicBrainz MBIDs (specifically musicbrainz_releasegroupid and musicbrainz_trackid). It then uses them to resolve the Genie album ID from the release or release group on MusicBrainz. Thus, at least one release in the release group must have a URL relationship to the album on Genie.

If successful, the lyrics will be downloaded and stored next to the audio files with the appropriate extension (.lrc or .txt, depending on whether they're synced or not).

Exclude files and folders

You can recursively ignore folders by adding a (empty) .nolyrics file inside the folder you want to exclude. This can be useful for Western artists, where Genie is unlikely to have lyrics, or for instrumental releases.

Likewise, you can ignore specific songs by creating a file with the same name as the audio file but the extension changed to .nolyrics. For example, a track named 01 Song.flac can be excluded by creating a file named 01 Song.nolyrics.

Excluded files won't be queried at all, which can noticeably speed up the synchronisation process for large collections.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lyriks-0.3.5.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lyriks-0.3.5-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file lyriks-0.3.5.tar.gz.

File metadata

  • Download URL: lyriks-0.3.5.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.7

File hashes

Hashes for lyriks-0.3.5.tar.gz
Algorithm Hash digest
SHA256 0c8ba412f7288bcef1570a3c9375284d199029891dd23b86807203f946ee44fd
MD5 6f890e9e86fa8d49648a9a3dca440302
BLAKE2b-256 7d5c5cf7c0773046b286b0983b7e7e32ff46a3b6831885070583ae1112076a80

See more details on using hashes here.

File details

Details for the file lyriks-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: lyriks-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.7

File hashes

Hashes for lyriks-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9c36de13b24ed7807bfc1812ae26c5133783200c9f4eabe09a0959f7c8d4ee4e
MD5 806a7fbee23baac101dcdf709a19d129
BLAKE2b-256 c478f48414d4974a128ec897a9ea304185ff1df822ec5d6d2f1c78fc00673a98

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page