Skip to main content

Download lyrics and metadata from Genius.com

Project description

LyricsGenius: a Python client for the Genius.com API

Build Status Documentation Status PyPI version Support this project

lyricsgenius provides a simple interface to the song, artist, and lyrics data stored on Genius.com.

The full documentation for lyricsgenius is available online at Read the Docs.

Setup

Before using this package you'll need to sign up for a (free) account that authorizes access to the Genius API. The Genius account provides a access_token that is required by the package. See the Usage section below for examples.

Installation

lyricsgenius requires Python 3.11 or greater.

Use pip to install the package from PyPI:

pip install lyricsgenius

Or, install the latest version of the package from GitHub:

pip install git+https://github.com/johnwmillr/LyricsGenius.git

Usage

Import the package and initiate Genius:

import lyricsgenius
genius = lyricsgenius.Genius(token)

If you don't pass a token to the Genius class, lyricsgenus will look for an environment variable called GENIUS_ACCESS_TOKEN and attempt to use that for authentication.

genius = Genius()

Search for songs by a given artist:

artist = genius.search_artist("Andy Shauf", max_songs=3, sort="title")
print(artist.songs)

By default, the search_artist() only returns songs where the given artist is the primary artist. However, there may be instances where it is desirable to get all of the songs that the artist appears on. You can do this by setting the include_features argument to True.

artist = genius.search_artist("Andy Shauf", max_songs=3, sort="title", include_features=True)
print(artist.songs)

Search for a single song by the same artist:

song = artist.song("To You")
# or:
# song = genius.search_song("To You", artist.name)
print(song.lyrics)

Add the song to the artist object:

artist.add_song(song)
# the Artist object also accepts song names:
# artist.add_song("To You")

Save the artist's songs to a JSON file:

artist.save_lyrics()

Searching for an album and saving it:

album = genius.search_album("The Party", "Andy Shauf")
album.save_lyrics()

There are various options configurable as parameters within the Genius class:

genius.remove_section_headers = True # Remove section headers (e.g. [Chorus]) from lyrics when searching
genius.skip_non_songs = False # Include hits thought to be non-songs (e.g. track lists)
genius.excluded_terms = ["(Remix)", "(Live)"] # Exclude songs with these words in their title

By default the library is silent. To enable progress logging:

import lyricsgenius
lyricsgenius.enable_logging()  # defaults to DEBUG; pass logging.INFO for less output

You can also call the package from the command line:

export GENIUS_ACCESS_TOKEN="my_access_token_here"
python -m lyricsgenius --help

# Print a song's lyrics to stdout in text format
python -m lyricsgenius song "Check the Rhyme" "A Tribe Called Quest" --format txt

# Save a song's lyrics in JSON format
python -m lyricsgenius song "Begin Again" "Andy Shauf" --format json --save

# Save a song's lyrics in both JSON and text formats
python -m lyricsgenius song "Begin Again" "Andy Shauf" --format json txt --save

# Save an artist's lyrics to text files (stopping after 2 songs)
python -m lyricsgenius artist "The Beatles" --max-songs 2 --format txt --save

Example projects

Contributing

Please contribute! If you want to fix a bug, suggest improvements, or add new features to the project, just open an issue or send me a pull request.

Project details


Download files

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

Source Distribution

lyricsgenius-3.12.2.tar.gz (518.5 kB view details)

Uploaded Source

Built Distribution

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

lyricsgenius-3.12.2-py3-none-any.whl (50.7 kB view details)

Uploaded Python 3

File details

Details for the file lyricsgenius-3.12.2.tar.gz.

File metadata

  • Download URL: lyricsgenius-3.12.2.tar.gz
  • Upload date:
  • Size: 518.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lyricsgenius-3.12.2.tar.gz
Algorithm Hash digest
SHA256 9a2a26c98e93b98ed3b65364e8e10627bb6e600c26e36ee8d0edb4bbd5b9ea2c
MD5 64b3f6bd3a065d6cb747d0747a4d34dd
BLAKE2b-256 546321b4712997061c2207cd3a78ee2365f32fa50750f306d6756a3c1e846ca7

See more details on using hashes here.

Provenance

The following attestation bundles were made for lyricsgenius-3.12.2.tar.gz:

Publisher: publish.yml on johnwmillr/LyricsGenius

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lyricsgenius-3.12.2-py3-none-any.whl.

File metadata

  • Download URL: lyricsgenius-3.12.2-py3-none-any.whl
  • Upload date:
  • Size: 50.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lyricsgenius-3.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9d74e0245d70c67986cf772a996c04ac2f4125efff7154f901ae48385b4b3ad6
MD5 9400450e518b9fb4b3bff7adfe4310b1
BLAKE2b-256 882ea084420f5e3c39817a6c501ecbe78c68cb5a83f05f26580acf8b453ee3c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for lyricsgenius-3.12.2-py3-none-any.whl:

Publisher: publish.yml on johnwmillr/LyricsGenius

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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