Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.6.1 instead.
Reason given by maintainers: Broken package

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.4.0-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.4.0.tar.gz (23.5 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.4.0-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lyriks-0.4.0.tar.gz
Algorithm Hash digest
SHA256 245d9c7330b32d5a784f116ff95ea5aeb9c073251bd046e8238031833883dcbb
MD5 da09d57965a6b37665a1579e2abba10b
BLAKE2b-256 b67b7fe490cd90f48ef333d3759d832832c9400fe09633dede034fbe3de2e98c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lyriks-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.6 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00f3ad5454e7d629bb969f1b214298519cf5f75424f423b43cbaf7580219eb86
MD5 4c7db7973ed55ca302dc135aa66c2493
BLAKE2b-256 ad5cbf678609620ec7d4222668d96bc133b2f62ee8d58bf8c7ed9829cbc0c571

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 Pingdom Monitoring Sentry Error logging StatusPage Status page