Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Download lyrics and metadata from Genius.com

Project description

Scraping song lyrics from Genius.com

Build Status PyPI version Python version

Setup

This repository is intended to provide an easy interface for programatically accessing the song information stored on Genius.com. Check out my blog post for a more thorough description of the package and its usage.

To use the Genius API you'll need to sign up for a (free) client that authorizes you to access their API. You'll need to supply your client_access_token from Genius when using this module. See Usage below for an example.

Installation

LyricsGenius requires Python 3.

The easiest way to start using this package is to install it via PyPI using pip:

$pip install lyricsgenius

If you'd prefer to clone the repository and install it yourself, follow these steps:

  1. Clone this repo: $git clone https://github.com/johnwmillr/LyricsGenius.git
  2. Enter the cloned directory: $cd LyricsGenius
  3. Install using pip: $pip install .

Usage

>>> import lyricsgenius as genius
>>> api = genius.Genius('my_client_access_token_here')
>>> artist = api.search_artist('Andy Shauf', max_songs=3)
Searching for Andy Shauf...

Song 1: "Alexander All Alone"
Song 2: "Begin Again"
Song 3: "Comfortable With Silence"

Reached user-specified song limit (3).
Found 3 songs.

Done.
>>> print(artist)
Andy Shauf, 3 songs
>>> song = api.search_song('To You',artist.name)
Searching for "To You" by Andy Shauf...
Done.
>>> print(song)
"To You" by Andy Shauf:
    Jeremy can we talk a minute
    I've got some things that I need to
    Get off of my chestI know that we h...
>>> artist.add_song(song)
>>> print(artist)
Andy Shauf, 4 songs
>>> artist.save_lyrics() # Saves artist's lyrics to a JSON file

You can also call the package from the command line. When ran from the command line, the package expects to find an environment variable with your Genius client access token.

$export GENIUS_CLIENT_ACCESS_TOKEN="my_client_access_token_here"
$python3 -m lyricsgenius --search-song 'Begin Again' 'Andy Shauf'
$python3 -m lyricsgenius --search-artist 'Lupe Fiasco' 3

Example projects

I'd love to have more examples to list here! Let me know if you've made use of this wrapper for one of your own projects, and I'll list it here.

Contributing

Please contribute! I'd love to have collaborators on this project. If you want to add features, suggest improvements, or have other comments, just make a pull request or raise an issue.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
lyricsgenius-0.9.5-py3-none-any.whl (13.0 kB) Copy SHA256 hash SHA256 Wheel py3 Sep 13, 2018
lyricsgenius-0.9.5.tar.gz (11.9 kB) Copy SHA256 hash SHA256 Source None Sep 13, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page