Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnwmillr/LyricsGenius
Download song lyrics and metadata from Genius.com 🎶🎤
https://github.com/johnwmillr/LyricsGenius
download-lyrics genius-api genius-lyrics lyrics python scraping-lyrics song-lyrics
Last synced: 7 days ago
JSON representation
Download song lyrics and metadata from Genius.com 🎶🎤
- Host: GitHub
- URL: https://github.com/johnwmillr/LyricsGenius
- Owner: johnwmillr
- License: mit
- Created: 2017-07-07T14:36:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T16:10:46.000Z (17 days ago)
- Last Synced: 2024-10-28T15:19:46.077Z (16 days ago)
- Topics: download-lyrics, genius-api, genius-lyrics, lyrics, python, scraping-lyrics, song-lyrics
- Language: Python
- Homepage: http://www.johnwmillr.com/scraping-genius-lyrics/
- Size: 1000 KB
- Stars: 912
- Watchers: 20
- Forks: 161
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# LyricsGenius: a Python client for the Genius.com API
[](https://travis-ci.org/johnwmillr/LyricsGenius)
[](https://lyricsgenius.readthedocs.io/en/latest/?badge=master)
[](https://pypi.org/project/lyricsgenius/)
[](https://pypi.org/project/lyricsgenius/)
[](https://github.com/sponsors/johnwmillr)
`lyricsgenius` provides a simple interface to the song, artist, and lyrics data stored on [Genius.com](https://www.genius.com).
The full documentation for `lyricsgenius` is available online at [Read the Docs](https://lyricsgenius.readthedocs.io/en/master/).
## Setup
Before using this package you'll need to sign up for a (free) account that authorizes access to [the Genius API](http://genius.com/api-clients). The Genius account provides a `access_token` that is required by the package. See the [Usage section](https://github.com/johnwmillr/LyricsGenius#usage) below for examples.
## Installation
`lyricsgenius` requires Python 3.
Use `pip` to install the package from PyPI:
```bash
pip install lyricsgenius
```
Or, install the latest version of the package from GitHub:
```bash
pip install git+https://github.com/johnwmillr/LyricsGenius.git
```
## Usage
Import the package and initiate Genius:
```python
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.
```python
genius = Genius()
```
Search for songs by a given artist:
```python
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`.
```python
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:
```python
song = artist.song("To You")
# or:
# song = genius.search_song("To You", artist.name)
print(song.lyrics)
```
Add the song to the artist object:
```python
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:
```python
artist.save_lyrics()
```
Searching for an album and saving it:
```python
album = genius.search_album("The Party", "Andy Shauf")
album.save_lyrics()
```
There are various options configurable as parameters within the `Genius` class:
```python
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:
```bash
export GENIUS_ACCESS_TOKEN="my_access_token_here"
python3 -m lyricsgenius --help
```
Search for and save lyrics to a given song and album:
```bash
python3 -m lyricsgenius song "Begin Again" "Andy Shauf" --save
python3 -m lyricsgenius album "The Party" "Andy Shauf" --save
```
Search for five songs by 'The Beatles' and save the lyrics:
```bash
python3 -m lyricsgenius artist "The Beatles" --max-songs 5 --save
```
## Example projects
- [Trucks and Beer: A textual analysis of popular country music](http://www.johnwmillr.com/trucks-and-beer/)
- [Neural machine translation: Explaining the Meaning Behind Lyrics](https://github.com/tsandefer/dsi_capstone_3)
- [What makes some blink-182 songs more popular than others?](http://jdaytn.com/posts/download-blink-182-data/)
- [Sentiment analysis on hip-hop lyrics](https://github.com/Hugo-Nattagh/2017-Hip-Hop)
- [Does Country Music Drink More Than Other Genres?](https://towardsdatascience.com/does-country-music-drink-more-than-other-genres-a21db901940b)
- [49 Years of Lyrics: Why So Angry?](https://towardsdatascience.com/49-years-of-lyrics-why-so-angry-1adf0a3fa2b4)
## Contributing
Please contribute! If you want to fix a bug, suggest improvements, or add new features to the project, just [open an issue](https://github.com/johnwmillr/LyricsGenius/issues) or send me a pull request.