Skip to content

Latest commit

 

History

History
executable file
·
185 lines (122 loc) · 3.47 KB

description.rst

File metadata and controls

executable file
·
185 lines (122 loc) · 3.47 KB
Raw

BLyrics's documentation!

BLyrics

BLyrics is a python client for leveraging the GENIUS API.

A CLI tool for interacting with Genius

It is also used for getting latest articles and song charts

Package features include

  1. Getting infomation
  • Songs
  • Artists
  • Lyrics
  • Annotations
  1. Saving prefrences
  • Artist Info
  • Song info and lyrics
  1. Latest information and articles
  • Headliner from genius.com
  • Oher articles
  • Charts

Requirements

  1. Python3
  2. Any Operating system
  3. An open mind

Installation

  1. Setup virtual enviroment

  2. Install from PyPi

    $ pip3 install blyrics

Functions

search_song(song)

For getting song info and lyrics - Params: - song: song title - Returns: - dict: a dictionary of song information and lyrics

Usage:

>>>from blyrics import Package
>>>Package = Package()
>>>
>>>song_info = Package.search_song(song='No Role Modelz')
>>>
>>>song_lyrics = song_info['Lyrics']
>>>print(song_lyrics)

save_song(song_info)

For saving song info - Params: - song_info: value returned by search_song

>>>Package.save_song(song_info = song_info)
Saving Complete...
>>>

search_artist(artist)

For getting artist info - Params: - artist: artist name - Returns: - dict: a dictionary of artist information

Usage:

>>>artist_info = Package.search_artist(artist='Cole')
>>>twitter = artist_info['Twitter Handle']
>>>print(twitter)

save_artist(artist_info)

For saving artist info - Params: - artist_info: value returned by search_artist

>>>Package.save_artist(artist_info=artist_info)
Saving Complete...
>>>

get_annotations(song_id)

For getting song annotations - Params: - song_id: song id gotten from search_song - Returns: - annotations: list of annotations and other important information

Usage:

>>>song_id = song_info['song_id']
>>>annotations = Package.get_annotations(song_id=song_id)

get_articles_links():

For getting links and titles of articles currently on the genius home page - Returns: - tuple: headliner and other articles

Usage:

>>>articles = Package.get_articles_links()
>>>print(aritcles)

get_article(link)

"""For getting an articles currently on the genius home page - Params: - link: article link gotten from get_article_links - Returns: - str: article content

Usage:

>>>headline = articles[0]
>>>links = [v for v in headline.values()]
>>>article = Package.get_article(link=links[0])
>>>print(article)

get_chart()

For getting chart of top trending songs - Returns: - tuple: ranks, song title and artist name

>>>chart = Package.get_chart()
>>>for i in range(len(chart[0])):
...    print(chart[0][i],'   ',chart[1][i],'  ',chart[2][i])

Contribute

License

Project licensed under the MIT license

Author