Tekore

Fixed
`SimpleShow` - add optional `total_episodes` parameter (190)

Added
- Client - required and optional scopes can now be determined in code for any endpoint of the client (180)
- Dependency to HTTPX upgraded to include version `0.13.*` (186)

Fixed
- Errors - correctly fall back to `ClientError` and `ServerError` when encountering an unknown status code (185)

This release significantly improves the overall structure of the library and provides quality of life enhancements to various tasks. Most notably, submodules were removed in favor of a flat structure. Everything is now imported from the top level with the exception of `models`.

Removed
- Importing from submodules (81)
- `OAuthError` in `auth` - see below for details (154)

Deprecated
- Playlist API - methods specifically for playlist tracks and `episodes_as_tracks` argument of `Spotify.playlist` (178)

Added
- Authentication - a list of scopes and strings is accepted in `scope` arguments (81)
- `Scope` operations were expanded to properly handle all combinations of `str`, `scope` and `Scope` (177)
- Playlist API - new methods to fully support episodes in playlists. The new endpoints are direct counterparts to `playlist_tracks_*` methods. (178)

Changed
Import structure
Submodules were removed in favor of a flat structure. In addition to simply relocating objects, some changes were made as well. (81)

- Options for senders and configuration are now set at the top level
- `AuthorisationScopes` was renamed to`scope`, and its alias `scopes` is no longer available
- Ready-made scopes `read`, `write` and `every` are now accessed via the `scope` enumeration

Response models
These changes aim to make models consistent and serialisation clear. (149)

- The JSON encoder used internally was made private
- Hierarchies and names of model base classes and member types changed
- Instead of using `str`, models are now converted to JSON using their `json` method
- As a result of the change above, the `repr` of models can be viewed simply with `print`. The `repr` of model lists was significantly improved. Viewing attributes of models produces consistent results.
- The `asbuiltin` method replaces `asdict` for models and was also added for lists of models. Enumerations and timestamps are no longer preserved in the conversion.
- `pprint` output is now compact by default

Playlist items
Boolean attributes of `FullTrack` and `FullEpisode` on a playlist were previously also available elsewhere, but had `None` values. They were removed. The booleans are still available in playlist-related calls with the new `FullPlaylistTrack` and `FullPlaylistEpisode`. `LocalPlaylistTrack` now also provides these booleans. (170)

Miscellaneous
- Exceptions thrown in authentication now match client. Because of that, `OAuthError` was removed. Errors now inherit from a common base class. (154)
- `Token.scope` and `RefreshingToken.scope` now return a `Scope` instead of a string. (177)
- Default sender changed from `TransientSender` to `PersistentSender`, also affects `Client` behavior (141)

Fixed
- Properly close sessions in `PersistentSender` (179)
- Members of `AlbumGroup` are now strings as intended, rather than one-element tuples (181)
- Include readme to source distributions to fix setup (182)

This is the first release to feature a streamlined import structure (only top level imports). All old-style imports (from submodules) are still available, a few still needed, but they will be removed in the next major release of Tekore, version 2.0.

Added
- Most imports can be done directly at the top level (174)

Deprecated
- Importing from submodules, removed in Tekore 2.0 (81)

Fixed
- `recommendations` documentation changed to reflect that only IDs are accepted as seeds, not URIs or URLs (173)
- `track_audio_analysis` allow for missing attributes in analysis (175)

Added
- Support for podcasts: new APIs for episodes and shows. New scope `user-read-playback-position` for returning episode resume points. New endpoints for saving shows in library. `playback_queue_add` now accepts episode URIs. `playback` and `playback_currently_playing` can return currently playing episodes and shows. `playlist` and `playlist_tracks` can return episodes on playlists. `search` allows for searching episodes and shows. (164)
- Dependency to HTTPX upgraded to include version `0.12.*` (166)

Fixed
- Errors are now correctly raised when parsing responses in `playlist` and `playlist_tracks` (164)
- Conversions `to_url` now return URLs with prefix ``https`` instead of ``http``, in line with API and application behavior.`from_url` now correctly accepts `https` addresses for conversion. (165)
- The `repr` of local items can now be produced without errors (171)

Added
- `RetryingSender` avoid unnecessary retries and reduce total wait time (163)

Fixed
- `category_playlists` require category parameter (160)
- `AsyncPersistentSender` persist connections appropriately (161)
- `playback_queue_add` match endpoint address to changed API (162)