spotify.py

An API library for the spotify client and the Spotify Web API written in Python.

Spotify.py is an asyncronous API library for Spotify. While maintaining an emphasis on being purely asyncronous the library provides syncronous functionality with the spotify.sync module.

import spotify.sync as spotify  # Nothing requires async/await now!

Index

Installing
Examples
Resources

Installing

To install the library simply clone it and run setup.py

git clone https://github.com/mental32/spotify.py
python3 setup.py install

or use pypi

pip3 install spotify (latest stable)
pip3 install -U git+https://github.com/mental32/spotify.py (nightly)

Examples

Sorting a playlist by popularity

import sys

import spotify

playlist_uri =   # Playlist uri here
client_id =      # App client id here
secret =         # App secret here
token =          # User token here

client = spotify.Client(client_id, secret)

async def main():
    user = await spotify.User.from_token(client, token)

    playlists = filter((lambda playlist: playlist.uri == playlist_uri), await user.get_playlists())

    try:
        playlist = next(playlists)
    except StopIteration:
        print('No playlists were found!', file=sys.stderr)
        return
    else:
        await playlist.sort(reverse=True, key=(lambda track: track.popularity))

if __name__ == '__main__':
    client.loop.run_until_complete(main())

Usage with flask

from typing import Tuple

import flask
import spotify.sync as spotify

SPOTIFY_CLIENT = spotify.Client('SPOTIFY_CLIENT_ID', 'SPOTIFY_CLIENT_SECRET')

APP = flask.Flask(__name__)
APP.config.from_mapping({'spotify_client': SPOTIFY_CLIENT})

REDIRECT_URI: str = 'http://localhost:8888/spotify/callback'

OAUTH2_SCOPES: Tuple[str] = ('user-modify-playback-state', 'user-read-currently-playing', 'user-read-playback-state')
OAUTH2: spotify.OAuth2 = spotify.OAuth2(SPOTIFY_CLIENT.id, REDIRECT_URI, scope=OAUTH2_SCOPES)

@APP.route('/spotify/callback')
def spotify_callback():
    try:
        code = flask.request.args['code']
    except KeyError:
        return flask.redirect('/spotify/failed')
    else:
        flask.session['spotify_user'] = spotify.User.from_code(
            SPOTIFY_CLIENT,
            code,
            redirect_uri=REDIRECT_URI,
            refresh=True
        )

    return flask.redirect('/')

@APP.route('spotify/failed')
def spotify_failed():
    flask.session.pop('spotify_user', None)
    return 'Failed to authenticate with Spotify.'

@APP.route('/')
@APP.route('/index')
def index():
    try:
        return repr(flask.session['spotify_user'])
    except KeyError:
        return flask.redirect(OAUTH2.url)

if __name__ == '__main__':
    APP.run('127.0.0.1', port=8888, debug=False)

Resources

For resources look at the examples or ask in the discord

Metadata

Release files for spotify 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spotify 0.6.1
File	Size	Uploaded	Provenance
spotify-0.6.1.tar.gz	34.8 kB	Sep 27, 2019	Without provenance	Details

Release files / spotify-0.6.1.tar.gz

Download URL	spotify-0.6.1.tar.gz
Size	34.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`fe03c80540e634227da5830265c0bdf5adc1cc7fef2f1a7c14052ce587b25480`
BLAKE2b-256 checksum How to use checksums	`40ffb5dc553b5b644fae0a278ce062b94dd227a5aacb0844d2d86158a56dc9ce`
Upload date	Sep 27, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4`

Security for spotify 0.6.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.