async-spotify 0.2.0

An async spotify api client

AsyncSpotify

Documentation

The full documentation can be viewed here.

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

pip install async-spotify

Example

For more in depth examples take a look here or visit the documentation.

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.