Metadata-Version: 2.1
Name: async-spotify
Version: 0.2.0
Summary: An async spotify api client
Home-page: https://github.com/HuiiBuh/AsyncSpotify
Author: HuiiBuh
Author-email: nhaderer1@gmail.com
License: UNKNOWN
Description: # AsyncSpotify
        
        ![Unit Tests](https://github.com/HuiiBuh/AsyncSpotify/workflows/Unit%20Tests/badge.svg)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/65dd7dbb2b4b4efcb3fc365f2d3f1684)](https://app.codacy.com/manual/nhaderer1/AsyncSpotify?utm_source=github.com&utm_medium=referral&utm_content=HuiiBuh/AsyncSpotify&utm_campaign=Badge_Grade_Dashboard)
        [![codecov](https://codecov.io/gh/HuiiBuh/AsyncSpotify/branch/master/graph/badge.svg?token=0oC3x1chKb)](https://codecov.io/gh/HuiiBuh/AsyncSpotify)
        
        ## Documentation
        
        The full documentation can be viewed [here](https://huiibuh.github.io/AsyncSpotify/).
        
        ## Why should you use this library
        
        + 100% Code coverage
        + Completely type annotated
        + Completely async
        + Scales up to (theoretically) unlimited requests per second (tested with 1000 simultaneous requests which lead to a 429)
        + Customize the timeout, maximal simultaneous request
        + Throws custom errors, so you can catch different errors easily
          + Token expiration
          + Rate limit violation
          + An invalid album id
        + Gets rid of the client credential workflow if you provide spotify cookies
          + Good for automated testing
        + Offers a hook which gets called if the token expires, so you can automatically update the token
        
        ## Installation
        
        You need at least python3.6 to install the package
        
        ```bash
        pip install async-spotify
        ```
        
        ## Example
        
        For more in depth examples take a look [here](EXAMPLES.md) or visit the documentation.
        
        ```python
        from async_spotify import Preferences, SpotifyApiClient, SpotifyAuthorisationToken
        
        # Create a preferences object and load the preferences from env variables
        preferences = Preferences()
        preferences.load_from_env()
        
        # Create a new Api client and pass the preferences
        api = SpotifyApiClient(preferences, hold_authentication=True)
        
        # Get the auth token with your code
        code: str = "Your Spotify Code"
        auth_token: SpotifyAuthorisationToken = await api.get_auth_token_with_code(code)
        
        # Create a new client
        await api.create_new_client(request_limit=1500)
        
        # Start making queries with the internally saved token
        album_tracks: dict = await api.albums.get_tracks('03dlqdFWY9gwJxGl3AREVy')
        
        # If you pass a valid auth_token this auth_token will be used for making the requests
        album_tracks: dict = await api.albums.get_tracks('03dlqdFWY9gwJxGl3AREVy', auth_token)
        ```
        
        ## Tests
        
        See [here](STUFF.md).
        
Keywords: Spotify,Async,API,Wrapper,AioHttp
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Software Development
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
