Skip to main content

An async spotify api client

Project description

AsyncSpotify

Unit Tests Codacy Badge codecov

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 SpotifyApiClient
from async_spotify.authentification import SpotifyAuthorisationToken
from async_spotify.authentification.authorization_flows import AuthorizationCodeFlow
# Create a auth_code_flow object and load the auth_code_flow from env variables
auth_flow = AuthorizationCodeFlow()
auth_flow.load_from_env()

# Create a new Api client and pass the auth_code_flow
api = SpotifyApiClient(auth_flow, 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

async-spotify-0.4.0.tar.gz (27.4 kB view details)

Uploaded Source

File details

Details for the file async-spotify-0.4.0.tar.gz.

File metadata

  • Download URL: async-spotify-0.4.0.tar.gz
  • Upload date:
  • Size: 27.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.5

File hashes

Hashes for async-spotify-0.4.0.tar.gz
Algorithm Hash digest
SHA256 2f40915de61bfa2b381d2f3e37dd031cd8f14b2fcf5d4884d8a709ce3bbfdf69
MD5 ae1798c003e727e76b5e966fd2cb5354
BLAKE2b-256 b7354fa9c7349facb08f0ae7fd18a76d15e878ec3e4b63d19f2feb4a5cf886e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page