SO业务编排>> LyricsGenius>> 返回
项目作者： johnwmillr

项目描述 ：
Download song lyrics and metadata from Genius.com 🎶🎤
高级语言： Python
项目地址: git://github.com/johnwmillr/LyricsGenius.git
创建时间： 2017-07-07T14:36:42Z
项目社区：https://github.com/johnwmillr/LyricsGenius
开源协议：MIT License
下载


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.

Use pip to install the package from PyPI:

  1. pip install lyricsgenius

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

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

Usage

Import the package and initiate Genius:

  1. import lyricsgenius
  2. 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.

  1. genius = Genius()

Search for songs by a given artist:

  1. artist = genius.search_artist("Andy Shauf", max_songs=3, sort="title")
  2. 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.

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

Search for a single song by the same artist:

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

Add the song to the artist object:

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

Save the artist’s songs to a JSON file:

  1. artist.save_lyrics()

Searching for an album and saving it:

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

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

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

You can also call the package from the command line:

  1. export GENIUS_ACCESS_TOKEN="my_access_token_here"
  2. python -m lyricsgenius --help
  4. # Print a song's lyrics to stdout in text format
  5. python -m lyricsgenius song "Check the Rhyme" "A Tribe Called Quest" --format txt
  7. # Save a song's lyrics in JSON format
  8. python -m lyricsgenius song "Begin Again" "Andy Shauf" --format json --save
  10. # Save a song's lyrics in both JSON and text formats
  11. python -m lyricsgenius song "Begin Again" "Andy Shauf" --format json txt --save
  13. # Save an artist's lyrics to text files (stopping after 2 songs)
  14. 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.