From fa4a3fa0896ec71ca5ee1860137c5c8385d266a6 Mon Sep 17 00:00:00 2001 From: morguldir Date: Sat, 20 Aug 2022 22:37:00 +0200 Subject: [PATCH] Create a migration guide from 0.6.x to 0.7.x --- docs/index.rst | 1 + docs/migration.rst | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/migration.rst diff --git a/docs/index.rst b/docs/index.rst index 4f60de2..2d969c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,5 +13,6 @@ Indices and tables playlist api history + migration genindex py-modindex diff --git a/docs/migration.rst b/docs/migration.rst new file mode 100644 index 0000000..0ff7b05 --- /dev/null +++ b/docs/migration.rst @@ -0,0 +1,19 @@ + +Migration guides +================ + + +Migrating from 0.6.x -> 0.7.x +----------------------------- + +This update added a lot more docstrings to functions, added pagination to most functions, +and it uses methods a lot more over functions that take id's, for example ``session.get_album_tracks(108064429)`` +is now ``session.album(108064429).tracks()`` instead + +Additionally a few of the pages have been deprecated on TIDAL's side and aren't being updated anymore, this applies to genres +and moods mostly, so see :ref:`pages` for how to find these at their new homes, but note that you will probably need to search + +Searching will be a bit more robust now, since you pass actual types, +instead of keywords matching the types. See :class:`~tidalapi.session.Session.search` for details + +Also generally instead of things like ``session.get_track(track_id)``, you will now use session.track(track_id) \ No newline at end of file