Download lyrics and metadata from Genius.com
Project description
LyricsGenius: a Python client for the Genius.com API
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.verbose = False # Turn off status messages
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
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
- Trucks and Beer: A textual analysis of popular country music
- Neural machine translation: Explaining the Meaning Behind Lyrics
- What makes some blink-182 songs more popular than others?
- Sentiment analysis on hip-hop lyrics
- Does Country Music Drink More Than Other Genres?
- 49 Years of Lyrics: Why So Angry?
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lyricsgenius-3.7.6.tar.gz.
File metadata
- Download URL: lyricsgenius-3.7.6.tar.gz
- Upload date:
- Size: 511.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd01ab819133e28f514985a61971fc4dc35751c4527e617ec49091390ddc3c9e
|
|
| MD5 |
73c58dc70411ddf7be1b38ea3b6a08c0
|
|
| BLAKE2b-256 |
20df27fa32747e5511157c3ed81870cbd2b094dd5f509ad37f34927b33783999
|
Provenance
The following attestation bundles were made for lyricsgenius-3.7.6.tar.gz:
Publisher:
publish.yml on johnwmillr/LyricsGenius
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
lyricsgenius-3.7.6.tar.gz -
Subject digest:
cd01ab819133e28f514985a61971fc4dc35751c4527e617ec49091390ddc3c9e - Sigstore transparency entry: 952374212
- Sigstore integration time:
-
Permalink:
johnwmillr/LyricsGenius@2eb41964ec781be390aedd0c8103c8f320e41cd6 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/johnwmillr
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@2eb41964ec781be390aedd0c8103c8f320e41cd6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file lyricsgenius-3.7.6-py3-none-any.whl.
File metadata
- Download URL: lyricsgenius-3.7.6-py3-none-any.whl
- Upload date:
- Size: 49.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2446ede5554cff0d96481dcde4194828e0205d2a84b17a94431077afa3e303a4
|
|
| MD5 |
51c4652e7d54ee8689c8ab5d90133201
|
|
| BLAKE2b-256 |
a9e44c5700a27e3bdf3c3b36b9d48457d70ed968eae0a9e099ca6e75b742218f
|
Provenance
The following attestation bundles were made for lyricsgenius-3.7.6-py3-none-any.whl:
Publisher:
publish.yml on johnwmillr/LyricsGenius
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
lyricsgenius-3.7.6-py3-none-any.whl -
Subject digest:
2446ede5554cff0d96481dcde4194828e0205d2a84b17a94431077afa3e303a4 - Sigstore transparency entry: 952374213
- Sigstore integration time:
-
Permalink:
johnwmillr/LyricsGenius@2eb41964ec781be390aedd0c8103c8f320e41cd6 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/johnwmillr
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@2eb41964ec781be390aedd0c8103c8f320e41cd6 -
Trigger Event:
push
-
Statement type: