Metadata-Version: 2.1
Name: blyrics
Version: 1.1
Summary: Python client for the GENIUS API -     Also for getting latest articles and charts
Home-page: https://github.com/BlankGodd/BLyrics
Author: Damilare Agbabiaka (BlankGodd)
Author-email: blankgodd33@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/BlankGodd/BLyrics/issues
Project-URL: Read the Docs, https://github.com/BlankGodd/BLyrics/wiki
Description: 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
        
        2. Saving prefrences
        
        -  Artist Info
        -  Song info and lyrics
        
        3. 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 <https://realpython.com/python-virtual-environments-a-primer/>`__
        
        2. Install from PyPi
        
           .. code:: sh
        
               $ 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:**
        
        .. 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
        ----------
        
        -  Issues: https://github.com/BlankGodd/BLyrics/issues
        -  Source Code: https://github.com/BlankGodd/BLyrics
        
        License
        -------
        
        Project licensed under the MIT license
        
        Author
        ------
        
        -  Nick: BlankGodd
        -  Email: blankgodd33@gmail.com
        -  Github: https://github.com/BlankGodd
        -  Twitter: @blankgodd\_
        
        
Keywords: music,lyrics,mp3,music charts,entertainment,genius,articles
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Topic :: Artistic Software
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Python: >=3.6
Description-Content-Type: text/markdown
