Add documentation for config, logging in and playlist modification

Author: morguldir

docs/config.rst

@@ -0,0 +1,13 @@
+
+Config
+======
+
+Here is an example of how you can modify the quality of tracks and videos, historically this has
+been done before initializing the session, since some api keys didn't support all qualities.
+
+.. testcode::
+
+    import tidalapi
+
+    config = tidalapi.Config(quality=tidalapi.Quality.lossless, video_quality=tidalapi.VideoQuality.low)
+    session = tidalapi.Session(config)

docs/index.rst

@@ -7,7 +7,10 @@ Indices and tables
 ==================
 
 .. toctree::
+    config
+    login
     pages
+    playlist
     api
     history
     genindex

docs/login.rst

@@ -0,0 +1,83 @@
+
+Login
+=====
+
+Here is an example of how you can login in a more advanced way, the login is a bit complicated since
+people use tidalapi in lots of different ways.
+
+See :class:`tidalapi.session` for additional information about the available fields and functions
+
+Customizable login
+-------------------------
+
+This will use a desktop notification to show the link used for logging in, you can also open the browser directly,
+display the code and tell the user to visit link.tidal.com and enter it, write it to a file, or send an email.
+
+See :class:`tidalapi.session.LinkLogin` for the fields you can use to print the link
+
+.. testsetup::
+
+    import tests.conftest
+    import requests
+    import sys
+    session = tests.conftest.login(requests.Session())
+    printer = lambda x: print(x, file=sys.stderr)
+
+.. testcode::
+
+    from plyer import notification
+
+    login, future = session.login_oauth()
+
+    notification.notify("Open the URL to log in", login.verification_uri_complete)
+
+    future.result()
+    print(session.check_login())
+
+.. testoutput::
+    :hide:
+
+    True
+
+Simple login
+------------
+This will print the link, and then wait for the login future to complete, but it's not very flexible
+
+.. testcode::
+
+    # The function is print by default, but you can use anything, here we do it to avoid the print being swallowed
+    session.login_oauth_simple(function=printer)
+    print(session.check_login())
+
+.. testoutput::
+    :hide:
+
+    True
+
+Storing login credentials
+-------------------------
+
+In order to store the login details, you need to store these variables in a secure place
+
+.. testcode::
+
+    token_type = session.token_type
+    access_token = session.access_token
+    refresh_token = session.refresh_token # Not needed if you don't care about refreshing
+    expiry_time = session.expiry_time
+
+
+Loading login credentials
+-------------------------
+
+Using the variables from the above snippet, we can login using stored credentials.
+This could for example be used to login on your computer, and then load the credentials in the cloud.
+
+.. testcode::
+
+    print(session.load_oauth_session(token_type, access_token, refresh_token, expiry_time))
+
+.. testoutput::
+    :hide:
+
+    True

docs/pages.rst

@@ -31,35 +31,37 @@ Goes through these pages and prints all of the categories and items
 
     for category in home.categories:
         print(category.title)
+        items = []
         for item in category.items:
             if isinstance(item, PageItem):
-                print("\t" + item.short_header)
-                print("\t" + item.short_sub_header[0:50])
+                items.append("\t" + item.short_header)
+                items.append("\t" + item.short_sub_header[0:50])
                 # Call item.get() on this one, for example on click
             elif isinstance(item, PageLink):
-                print("\t" + item.title)
+                items.append("\t" + item.title)
                 # Call item.get() on this one, for example on click
             elif isinstance(item, Mix):
-                print("\t" + item.title)
+                items.append("\t" + item.title)
                 # You can optionally call item.get() to request the items() first, but it does it for you if you don't
             else:
-                print("\t" + item.name)
+                items.append("\t" + item.name)
                 # An album could be handled by session.album(item.id) for example,
                 # to get full details. Usually the relevant info is there already however
             print()
+        [print(x) for x in sorted(items)]
 
 .. testoutput::
     :hide:
     :options: +ELLIPSIS, +NORMALIZE_WHITESPACE
 
     For You...
     Recently Played...
-    Mixes For You...
-    Trending Playlists...
-    Radio Stations for You...
     Suggested New Tracks...
     Suggested New Albums...
+    Mixes For You...
+    Radio Stations for You...
     Your History...
+    Trending Playlists...
     Popular Playlists...
     TIDAL Rising...
     The Charts...

docs/playlist.rst

@@ -0,0 +1,61 @@
+
+Playlists
+=========
+
+This library allows you to create, modify and delete playlists, note that this is mostly about
+the :class:`tidalapi.playlist.UserPlaylist` class, you can't modify other's playlists
+
+
+Creating a playlist
+-------------------
+
+.. testsetup::
+
+    import tests.conftest
+    import requests
+    session = tests.conftest.login(requests.Session())
+
+.. testcode::
+
+    playlist = session.user.create_playlist("Example playlist", "An example of a playlist")
+    print(playlist.name)
+
+.. testoutput::
+    :hide:
+
+    Example playlist
+
+Adding to a playlist
+--------------------
+
+.. testcode::
+
+    playlist.add([133937137, 71823815])
+    [print(x.name) for x in playlist.tracks()]
+
+.. testoutput::
+    :hide:
+
+    Worlds Collide
+    Lost Forever
+
+Removing from a playlist
+------------------------
+
+.. testcode::
+
+    playlist.remove_by_index(0)
+    playlist.remove_by_id(71823815)
+    print(playlist.tracks())
+
+.. testoutput::
+    :hide:
+
+    []
+
+Deleting a playlist
+-------------------
+
+.. testcode::
+
+    playlist.delete()