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
- Songs
- Artists
- Lyrics
- Annotations
- Artist Info
- Song info and lyrics
- Latest information and articles
- Headliner from genius.com
- Oher articles
- Charts
Requirements
- Python3
- Any Operating system
- An open mind
Installation
Functions
search_song(song)
^^^^^^^^^^^^^^^^^^
For getting song info and lyrics - Params: - song: song title - Returns:
- dict: a dictionary of song information and lyrics
Usage:
.. code:: py
>>>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
.. code:: py
>>>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:
.. code:: py
>>>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
.. code:: py
>>>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:
.. code:: py
>>>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:
.. code:: py
>>>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:
.. code:: py
>>>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
.. code:: py
>>>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