- update to 2.24.0:
* Added `MemcacheCacheHandler`, a cache handler that stores the
token info using pymemcache.
* Added support for audiobook endpoints: `get_audiobook`,
`get_audiobooks`, and `get_audiobook_chapters`.
* Added integration tests for audiobook endpoints.
* Added `update` field to `current_user_follow_playlist`.
* Fixed error obfuscation when Spotify class is being inherited
and an error is raised in the Child's `__init__`
* Replaced `artist_albums(album_type=...)` with
`artist_albums(include_groups=...)` due to an API change.
* Updated `_regex_spotify_url` to ignore `/intl-<countrycode>`
in Spotify links
OBS-URL: https://build.opensuse.org/request/show/1179665
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-spotipy?expand=0&rev=12
* Added `MemcacheCacheHandler`, a cache handler that stores the
token info using pymemcache.
* Added support for audiobook endpoints: `get_audiobook`,
`get_audiobooks`, and `get_audiobook_chapters`.
* Added integration tests for audiobook endpoints.
* Added `update` field to `current_user_follow_playlist`.
* Fixed error obfuscation when Spotify class is being inherited
and an error is raised in the Child's `__init__`
* Replaced `artist_albums(album_type=...)` with
`artist_albums(include_groups=...)` due to an API change.
* Updated `_regex_spotify_url` to ignore `/intl-<countrycode>`
in Spotify links
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=26
* Added optional `encoder_cls` argument to `CacheFileHandler`,
which overwrite default encoder for token before writing to
disk
* Integration tests for searching multiple types in multiple
markets (non-user endpoints)
* Publish to PyPI action
* Fixed the regex for matching playlist URIs with the format
spotify:user:USERNAME:playlist:PLAYLISTID.
* `search_markets` now factors the counts of all types in the
`total` rather than just the first type (#534)
* Add alternative module installation instruction to README
* Added Comment to README - Getting Started for user to add URI
to app in Spotify Developer Dashboard.
* Added playlist_add_tracks.py to example folder
* Modified docstring for playlist_add_items() to accept "only
URIs or URLs",
* with intended deprecation for IDs in v3
* Path traversal vulnerability that may lead to type confusion
in URI handling code
* Update contributing.md
- Update to version 2.22.0
- Update to version 2.21.0
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=24
- Update to version 2.22.0
* Added
Integration tests via GHA (non-user endpoints)
Unit tests for new releases, passing limit parameter with minimum and maximum values of 1 and 50
Unit tests for categories, omitting country code to test global releases
Added CODE_OF_CONDUCT.md
* Fixed
Incorrect category_id input for test_category
Assertion value for test_categories_limit_low and test_categories_limit_high
Pin Github Actions Runner to Ubuntu 20 for Py27
Fixed potential error where found variable in test_artist_related_artists is undefined if for loop never evaluates to true
Fixed false positive test test_new_releases which looks up the wrong property of the JSON response object and always evaluates to true
OBS-URL: https://build.opensuse.org/request/show/1042751
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=22
- Update to version 2.21.0
Added
* Added market parameter to album and albums to address #753
* Added 'show_featured_artists.py' to 'examples'.
* Expanded contribution and license sections of the documentation.
* Added FlaskSessionCacheHandler, a cache handler that stores the token info in a flask session.
* Added Python 3.10 in GitHub Actions
Fixed
* Updated the documentation to specify ISO-639-1 language codes.
* Fix AttributeError for text attribute of the Response object
* Require redis v3 if python2.7 (fixes readthedocs)
OBS-URL: https://build.opensuse.org/request/show/1034930
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=20
- version update to 2.19.0
## [2.19.0] - 2021-08-12
### Added
* Added `MemoryCacheHandler`, a cache handler that simply stores the token info in memory as an instance attribute of this class.
* If a network request returns an error status code but the response body cannot be decoded into JSON, then fall back on decoding the body into a string.
* Added `DjangoSessionCacheHandler`, a cache handler that stores the token in the session framework provided by Django. Web apps using spotipy with Django can directly use this for cache handling.
### Fixed
* Fixed a bug in `CacheFileHandler.__init__`: The documentation says that the username will be retrieved from the environment, but it wasn't.
* Fixed a bug in the initializers for the auth managers that produced a spurious warning message if you provide a cache handler and you set a value for the "SPOTIPY_CLIENT_USERNAME" environment variable.
* Use generated MIT license and fix license type in `pip show`
## [2.18.0] - 2021-04-13
### Added
- Enabled using both short and long IDs for playlist_change_details
- Added a cache handler to `SpotifyClientCredentials`
- Added the following endpoints
* `Spotify.current_user_saved_episodes`
* `Spotify.current_user_saved_episodes_add`
* `Spotify.current_user_saved_episodes_delete`
* `Spotify.current_user_saved_episodes_contains`
* `Spotify.available_markets`
### Changed
- Add support for a list of scopes rather than just a comma separated string of scopes
### Fixed
* Fixed the bugs in `SpotifyOAuth.refresh_access_token` and `SpotifyPKCE.refresh_access_token` which raised the incorrect exception upon receiving an error response from the server. This addresses #645.
* Fixed a bug in `RequestHandler.do_GET` in which the non-existent `state` attribute of `SpotifyOauthError` is accessed. This bug occurs when the user clicks "cancel" in the permissions dialog that opens in the browser.
* Cleaned up the documentation for `SpotifyClientCredentials.__init__`, `SpotifyOAuth.__init__`, and `SpotifyPKCE.__init__`.
## [2.17.0] - 2021-02-28
### Changed
- 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
OBS-URL: https://build.opensuse.org/request/show/970741
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=16
- Update to 2.16.1:
* Fixed
+ 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()
+ Enable retries for POST, DELETE, PUT (#577)
* Changed
+ both inline and starting import lists are sorted using isort
module
+ changed Max Retries exception code from 599 to 429
- Update to 2.16.0:
* Added
+ open_browser can be passed to the constructors of
SpotifyOAuth and SpotifyPKCE to make it easier to authorize
in browserless environments
- Update to 2.15.0:
* Added
+ SpotifyPKCE.parse_auth_response_url, mirroring that method in
SpotifyOAuth
* Changed
+ Specifying a cache_path or username is now optional
* Fixed
+ Using SpotifyPKCE.get_authorization_url will now generate a
code challenge if needed
- Update to 2.14.0:
* Added
OBS-URL: https://build.opensuse.org/request/show/844822
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=14
- Update to 2.13.0:
* Added
+ 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 of `SpotifyOauthError`
+ Allow extending `SpotifyClientCredentials` and `SpotifyOAuth`
+ Added the market paramter to `album_tracks`
+ Added a method to update the auth token.
+ Support for shows/podcasts and episodes
+ Added CONTRIBUTING.md
* Deprecated
+ Deprecated `util.prompt_for_user_token` in favor of `spotipy.Spotify(auth_manager=SpotifyOAuth())`
* Fixed
+ Logging regression due to the addition of `logging.basicConfig()` which was unneeded.
+ Issue where using `http://localhost` as redirect_uri would cause the authorization process to hang.
+ Fixed miscellaneous issues with parsing of callback URL
+ Close session when Spotipy object is unloaded
+ Propagate refresh token error
* Changed
+ 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` or `http://127.0.0.1:8080`, not for `http://localhost`.
+ Client retry logic has changed as it now uses urllib3's `Retry` in conjunction with requests `Session`
+ 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
- Skip one test that requires external internet access
OBS-URL: https://build.opensuse.org/request/show/819125
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-spotipy?expand=0&rev=5
* Added
+ 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 of `SpotifyOauthError`
+ Allow extending `SpotifyClientCredentials` and `SpotifyOAuth`
+ Added the market paramter to `album_tracks`
+ Added a method to update the auth token.
+ Support for shows/podcasts and episodes
+ Added CONTRIBUTING.md
* Deprecated
+ Deprecated `util.prompt_for_user_token` in favor of `spotipy.Spotify(auth_manager=SpotifyOAuth())`
* Fixed
+ Logging regression due to the addition of `logging.basicConfig()` which was unneeded.
+ Issue where using `http://localhost` as redirect_uri would cause the authorization process to hang.
+ Fixed miscellaneous issues with parsing of callback URL
+ Close session when Spotipy object is unloaded
+ Propagate refresh token error
* Changed
+ 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` or `http://127.0.0.1:8080`, not for `http://localhost`.
+ Client retry logic has changed as it now uses urllib3's `Retry` in conjunction with requests `Session`
+ 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
- Skip one test that requires external internet access
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=12
- version update to 2.9.0
* Support `position_ms` optional parameter in `start_playback`
* Add `requests_timeout` parameter to authentication methods
* Make cache optional in `get_access_token`
* Support for `playlist_cover_image`
* Support `after` and `before` parameter in `current_user_recently_played`
* CI for unit tests
* Automatic `token` refresh
* `auth_manager` and `oauth_manager` optional parameters added to `Spotify`'s init.
* Optional `username` parameter to be passed to `SpotifyOAuth`, to infer a `cache_path` automatically
* Optional `as_dict` parameter to control `SpotifyOAuth`'s `get_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 to `SpotifyOAuth`
* Both `SpotifyClientCredentials` and `SpotifyOAuth` inherit from a common `SpotifyAuthBase` which handles common parameters and logics.
* Support for `playlist_tracks`
* Support for `playlist_upload_cover_image`
* `user_playlist_tracks` doesn't require a user anymore (accepts `None`)
* Deprecated `user_playlist` and `user_playlist_tracks`
* 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
* 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`
* Added follow and player endpoints
OBS-URL: https://build.opensuse.org/request/show/785943
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-spotipy?expand=0&rev=8
