MetroLyrics API
Project description
This repo is actually not directly related to Taylor Swift. It’s just a simple Python API for getting lyrics from MetroLyrics. Here is how easy it is:
from tswift import Artist
import random
tswift = Artist('Taylor Swift')
song = random.choice(tswift.songs)
print(song.format())
Setup
This package depends on lxml, requests, and google. These should be installed when you install this package from pip:
pip install tswift
After installing, you can also print a random Taylor Swift song lyric with the command:
tswift
CLI
The module comes with a simple command line interface. By default, it will display a random song by Taylor Swift. You can specify an artist like this:
tswift 'Lynyrd Skynyrd'
You can choose a particular song:
tswift 'Lynyrd Skynyrd' -s Freebird
There is also a “lyric search mode”, which allows you to search for a song by lyrics, e.g.:
tswift -l 'I would walk 500 miles'
Im Gonna Be 500 Miles
Proclaimers
---------------------
When I wake up, well I know I'm gonna be,
I'm gonna be the man who wakes up next you
...
API
Artist class
The constructor takes a single argument, the artist name. This name will be “slugified” in order to use it within URLs. This process involves replacing spaces with hyphens, and making everything lowercase. If this is not sufficient for your particular artist, you’ll need to provide a pre-slugified version of their name.
songs - a list of Song instances by this artist. This will call load() if it hasn’t been called yet
name - the artist’s slugified name
load() - populates the songs list
Song class
The constructor can be called in two ways. In the first, you provide a Metrolyrics URL, and the class will infer the artist and song title:
s = Song(url='url here')
In the second way, you provide a title and artist, which will be slugified.
s = Song('Taylor Swift', 'Love Story')
The attributes are:
lyrics - a string. Accessing this will call load() if not yet loaded
title - de-slugified title of song
artist - de-slugified artist name
load() - loads the lyrics
format() - returns the lyrics, with a header that includes the title and artist.
The static method Song.find_song(lyrics) takes a string with a search term, and performs a Google search. It returns a Song instance corresponding to the first Metrolyrics link it finds, stopping after 20 results. If nothing is found, returns None.
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
Built Distribution
Hashes for tswift-0.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4edfaebc0e6256612499de12fe93c93204e38fecc44e7d41166137e1d6d636d9 |
|
MD5 | 6164d9c0ec2eb32e07e207ff49056df3 |
|
BLAKE2b-256 | 7a06e7410426ee39b18d3b927b2000f3c2815378f97b881cc288212012d0f883 |