All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Enabled using both short and long IDs for playlist_change_details
- Add support for a list of scopes rather than just a comma separated string of scopes
allowed_methods
requires urllib3>=1.26.0
- moved os.remove(session_cache_path()) inside try block to avoid TypeError on app.py example file
- A warning will no longer be emitted when the cache file does not exist at the specified path
- The docs for the
auth
parameter ofSpotify.init
use the term "access token" instead of "authorization token" - Changed docs for
search
to mention that you can provide multiple types to search for - The query parameters of requests are now logged
- Deprecate specifing
cache_path
orusername
directly toSpotifyOAuth
,SpotifyPKCE
, andSpotifyImplicitGrant
constructors, instead directing users to use theCacheFileHandler
cache handler - Removed requirement for examples/app.py to specify port multiple times (only SPOTIPY_REDIRECT_URI needs to contain the port)
- Added log messages for when the access and refresh tokens are retrieved and when they are refreshed
- Support
market
optional parameter intrack
- Added CacheHandler abstraction to allow users to cache tokens in any way they see fit
- Fixed Spotify.user_playlist_reorder_tracks calling Spotify.playlist_reorder_tracks with an incorrect parameter order
- Fixed deprecated Urllib3
Retry(method_whitelist=...)
in favor ofRetry(allowed_methods=...)
- playlist_tracks example code no longer prints extra characters on final loop iteration
- SpotifyException now thrown when a request fails & has no response (#571, #581)
- Added scope,
playlist-read-private
, to examples that access user playlists using the spotipy api: current_user_playlists() (#591) - Enable retries for POST, DELETE, PUT (#577)
- both inline and starting import lists are sorted using
isort
module - changed Max Retries exception code from 599 to 429
open_browser
can be passed to the constructors ofSpotifyOAuth
andSpotifyPKCE
to make it easier to authorize in browserless environments
SpotifyPKCE.parse_auth_response_url
, mirroring that method inSpotifyOAuth
- Specifying a cache_path or username is now optional
- Using
SpotifyPKCE.get_authorization_url
will now generate a code challenge if needed
- (experimental) Support to search multiple/all markets at once.
- Support to test whether the current user is following certain users or artists
- Proper replacements for all deprecated playlist endpoints (See https://developer.spotify.com/community/news/2018/06/12/changes-to-playlist-uris/ and below)
- Allow for OAuth 2.0 authorization by instructing the user to open the URL in a browser instead of opening the browser.
- Reason for 403 error in SpotifyException
- Support for the PKCE Auth Flow
- Support to advertise different language to Spotify
- Added 'collaborative' parameter to user_playlist_create method.
- Enforce CHANGELOG update on PR
- Adds
additional_types
parameter to retrieve currently playing podcast episode - Support to get info about a single category
user_playlist_change_details
in favor ofplaylist_change_details
user_playlist_unfollow
in favor ofcurrent_user_unfollow_playlist
user_playlist_add_tracks
in favor ofplaylist_add_items
user_playlist_replace_tracks
in favor ofplaylist_replace_items
user_playlist_reorder_tracks
in favor ofplaylist_reorder_items
user_playlist_remove_all_occurrences_of_tracks
in favor ofplaylist_remove_all_occurrences_of_items
user_playlist_remove_specific_occurrences_of_tracks
in favor ofplaylist_remove_specific_occurrences_of_items
user_playlist_follow_playlist
in favor ofcurrent_user_follow_playlist
user_playlist_is_following
in favor ofplaylist_is_following
playlist_tracks
in favor ofplaylist_items
- fixed issue where episode URIs were being converted to track URIs in playlist calls
- Added
SpotifyImplicitGrant
as an auth manager option. It provides user authentication without a client secret but sacrifices the ability to refresh the token without user input. (However, read the class docstring for security advisory.) - Added built-in verification of the
state
query parameter - Added two new attributes: error and error_description to
SpotifyOauthError
exception class to show authorization/authentication web api errors details. - Added
SpotifyStateError
subclass ofSpotifyOauthError
- Allow extending
SpotifyClientCredentials
andSpotifyOAuth
- Added the market paramter to
album_tracks
- Deprecated
util.prompt_for_user_token
in favor ofspotipy.Spotify(auth_manager=SpotifyOAuth())
- Added a method to update the auth token.
- Logging regression due to the addition of
logging.basicConfig()
which was unneeded.
-
Updated the documentation to give more details on the authorization process and reflect 2020 Spotify Application jargon and practices.
-
The local webserver is only started for localhost redirect_uri which specify a port, i.e. it is started for
http://localhost:8080
orhttp://127.0.0.1:8080
, not forhttp://localhost
.
- Issue where using
http://localhost
as redirect_uri would cause the authorization process to hang.
- Fixed miscellaneous issues with parsing of callback URL
- Support for shows/podcasts and episodes
- Added CONTRIBUTING.md
- Client retry logic has changed as it now uses urllib3's
Retry
in conjunction with requestsSession
- The session is customizable as it allows for:
- status_forcelist
- retries
- status_retries
- backoff_factor
- Spin up a local webserver to auto-fill authentication URL
- Use session in SpotifyAuthBase
- Logging used instead of print statements
- Close session when Spotipy object is unloaded
- Propagate refresh token error
- Support for
add_to_queue
- Parameters:
- track uri, id, or url
- device id. If None, then the active device is used.
- Parameters:
- Add CHANGELOG and LICENSE to released package
- Support
position_ms
optional parameter instart_playback
- Add
requests_timeout
parameter to authentication methods - Make cache optional in
get_access_token
- Support for
playlist_cover_image
- Support
after
andbefore
parameter incurrent_user_recently_played
- CI for unit tests
- Automatic
token
refresh auth_manager
andoauth_manager
optional parameters added toSpotify
's init.- Optional
username
parameter to be passed toSpotifyOAuth
, to infer acache_path
automatically - Optional
as_dict
parameter to controlSpotifyOAuth
'sget_access_token
output type. However, this is going to be deprecated in the future, and the method will always return a token string - Optional
show_dialog
parameter to be passed toSpotifyOAuth
- Both
SpotifyClientCredentials
andSpotifyOAuth
inherit from a commonSpotifyAuthBase
which handles common parameters and logics.
- PyPi release mistake without pulling last merge first
- Support for
playlist_tracks
- Support for
playlist_upload_cover_image
user_playlist_tracks
doesn't require a user anymore (acceptsNone
)
- Deprecated
user_playlist
anduser_playlist_tracks
- Fixed broken doc in 2.6.2
- Fixed broken examples in README, examples and doc
- Allow session keepalive
- Bump requests to 2.20.0
- Fixed inconsistent behaviour with some API methods when a full HTTP URL is passed.
- Fixed invalid calls to logging warn method
mock
no longer needed for install. Only used intox
.
- Support for
playlist
to get a playlist without specifying a user - Support for
current_user_saved_albums_delete
- Support for
current_user_saved_albums_contains
- Support for
user_unfollow_artists
- Support for
user_unfollow_users
- Lint with flake8 using Github action
- Fix typos in doc
- Start following SemVer properly
Added follow and player endpoints
Python 3 fix
Fixed proxy issue in standard auth flow
Support getting audio features for a single track
Incorporated proxy support
Incorporated a number of PRs
Added recs, audio features, user top lists
Added current_user_followed_artists
Support for offset/limit with album_tracks API
Fixed bug in auto retry logic
Aadded client credential flow
Added auto retry logic
Added session support added by akx.
Added support for user_playlist_tracks
Added support for new_releases and featured_playlists
Moved to spotipy at pypi
Upgraded APIs and docs to make it be a real library
Added playlist replace and remove methods. Added auth tests. Improved API docs
Upgraded version number to take precedence over previously botched release (sigh)
Refactored util out of examples and into the main package
Support for "Your Music" tracks (add, delete, get), with examples
Support for related artists endpoint. Don't use cache auth codes when scope changes
Added show tracks.py example
Fixed JSON handling issue
Removed dependency on simplejson
Initial public release.
Added support for retrieving starred playlists
Updates to match released API
Repackaged for saner imports
Initial release