Metadata-Version: 2.1
Name: wavyfm
Version: 1.0.1
Summary: Official Python library for wavy.fm
Home-page: https://wavy.fm/developers
Author: Aram Peres
Author-email: aram.peres@wavy.fm
License: LICENSE.md
Project-URL: Documentation, https://github.com/wavy/wavyfm-python
Project-URL: Source, https://github.com/wavy/wavyfm-python
Description: # wavyfm-python
        
        **The Python client library for [wavy.fm](https://wavy.fm), officially maintained by Wavy Labs.**
        
        ![Tests](https://github.com/wavy/wavyfm-python/workflows/Tests/badge.svg)
        
        ## Documentation
        
        > Coming soon!
        
        ## Installation
        
        This library is built with Python 3.8. You can install it from pypi:
        
        ```bash
        pip install wavyfm
        ```
        
        ## Quick Start
        
        To get started, install the `wavyfm` package and create an app on https://wavy.fm/developers/apps. Add your client ID
        and client secret to your environment variables:
        
        ```
        WAVYFM_CLIENT_ID='pub_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
        WAVYFM_CLIENT_SECRET='priv_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
        ```
        
        ## Without user authentication
        
        ```python
        import wavyfm
        
        # Create the client
        wavy = wavyfm.WavyClient(auth_manager=wavyfm.WavyClientCredentials())
        
        # Get the total listens recorded on wavy.fm
        print(wavy.metrics.get_total_listens())
        
        # Get the total amount of registered users on wavy.fm
        print(wavy.metrics.get_total_users())
        
        # Get the top 10 registered users on wavy.fm by listen count
        print(wavy.metrics.get_user_listens_leaderboard())
        
        # Get a user's public profile
        print(wavy.users.by_username("Aram").get_profile())
        
        # Get a user's total listens
        print(wavy.users.by_username("Aram").get_total_listens())
        
        # Get a user's total artists
        print(wavy.users.by_username("Aram").get_total_artists())
        
        # Get a user's currently listening track
        print(wavy.users.by_username("Aram").get_currently_listening())
        
        # Get a user's last 10 recorded listens
        print(wavy.users.by_username("Aram").get_recent_listens(10))
        ```
        
        ## License
        
        This project is licenced under the MIT License.
        
        The overall structure is heavily inspired from [Spotipy](https://github.com/plamere/spotipy), a client library for
        Spotify.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: doc
Provides-Extra: test
