A light weight Python library for the Spotify Web API
Go to file
darwady2 c6b56a658a
Add YT video URL to doc (#816)
For a final assignment in a class, I've created a How-To video that showcases how to get setup with API credentials, Redirect URIs, and Spotify Developer Accounts, all of which are necessary prerequisites to using the Spotipy library.

I wanted to do this because, in my past experience, the most frustrating thing about working with APIs and libraries is authentication. Spotipy does a nice job of wrapping some of this and making it easier on the developer, but it still takes some setup before successful use.

Specifically, my video goes through the following:
* Installing Spotipy
* Setting up a Spotify Developer Account
* Configuring the Redirect URI
* Getting the Client Secret and Public Keys
* Setting the envars for use with Spotipy
* Running a sample piece of code from Spotipy to show that things are setup properly
2022-06-18 23:20:11 +01:00
.github Removed Python 3.5 and added Python 3.9 in Github Action (#831) 2022-06-18 22:56:42 +01:00
docs Add YT video URL to doc (#816) 2022-06-18 23:20:11 +01:00
examples Added a new example: follow_playlist.py (#804) 2022-06-18 23:19:27 +01:00
spotipy Updated documentation about ISO-639 language codes and address issue #753 (#800) 2022-06-18 23:18:59 +01:00
tests Bump to 2.19.0 2021-08-12 11:27:26 +01:00
.gitignore Update recommendations doc, fixes #290 2020-02-22 13:08:26 +00:00
CHANGELOG.md Updated documentation about ISO-639 language codes and address issue #753 (#800) 2022-06-18 23:18:59 +01:00
CONTRIBUTING.md Fix lint 2021-02-28 10:16:21 +01:00
FAQ.md Update urllib3, fixes #647 (#648) 2021-02-28 14:53:02 +01:00
LICENSE.md Bump to 2.19.0 2021-08-12 11:27:26 +01:00
MANIFEST.in Release with CHANGELOG + LICENSE, solves #454 2020-03-18 20:34:22 +00:00
README.md Made cache_path and username optional (#567) 2020-08-30 23:59:38 +01:00
setup.py Add GitHub URL for PyPi (#787) 2022-06-18 23:18:20 +01:00
tox.ini Linting of core subpackage + clean up imports (#437) 2020-02-09 12:59:20 +00:00

Spotipy

A light weight Python library for the Spotify Web API

Tests Documentation Status

Documentation

Spotipy's full documentation is online at Spotipy Documentation.

Installation

pip install spotipy

or upgrade

pip install spotipy --upgrade

Quick Start

A full set of examples can be found in the online documentation and in the Spotipy examples directory.

To get started, install spotipy and create an app on https://developers.spotify.com/. Add your new ID and SECRET to your environment:

Without user authentication

import spotipy
from spotipy.oauth2 import SpotifyClientCredentials

sp = spotipy.Spotify(auth_manager=SpotifyClientCredentials(client_id="YOUR_APP_CLIENT_ID",
                                                           client_secret="YOUR_APP_CLIENT_SECRET"))

results = sp.search(q='weezer', limit=20)
for idx, track in enumerate(results['tracks']['items']):
    print(idx, track['name'])

With user authentication

import spotipy
from spotipy.oauth2 import SpotifyOAuth

sp = spotipy.Spotify(auth_manager=SpotifyOAuth(client_id="YOUR_APP_CLIENT_ID",
                                               client_secret="YOUR_APP_CLIENT_SECRET",
                                               redirect_uri="YOUR_APP_REDIRECT_URI",
                                               scope="user-library-read"))

results = sp.current_user_saved_tracks()
for idx, item in enumerate(results['items']):
    track = item['track']
    print(idx, track['artists'][0]['name'], "  ", track['name'])

Reporting Issues

For common questions please check our FAQ.

You can ask questions about Spotipy on Stack Overflow. Dont forget to add the Spotipy tag, and any other relevant tags as well, before posting.

If you have suggestions, bugs or other issues specific to this library, file them here. Or just send a pull request.