Skip to content

Commit fa4a3fa

Browse files
committed
Create a migration guide from 0.6.x to 0.7.x
1 parent ba664f8 commit fa4a3fa

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ Indices and tables
1313
playlist
1414
api
1515
history
16+
migration
1617
genindex
1718
py-modindex

docs/migration.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
Migration guides
3+
================
4+
5+
6+
Migrating from 0.6.x -> 0.7.x
7+
-----------------------------
8+
9+
This update added a lot more docstrings to functions, added pagination to most functions,
10+
and it uses methods a lot more over functions that take id's, for example ``session.get_album_tracks(108064429)``
11+
is now ``session.album(108064429).tracks()`` instead
12+
13+
Additionally a few of the pages have been deprecated on TIDAL's side and aren't being updated anymore, this applies to genres
14+
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
15+
16+
Searching will be a bit more robust now, since you pass actual types,
17+
instead of keywords matching the types. See :class:`~tidalapi.session.Session.search` for details
18+
19+
Also generally instead of things like ``session.get_track(track_id)``, you will now use session.track(track_id)

0 commit comments

Comments
 (0)