:py:mod:`calliope.shuffle`
==========================

.. py:module:: calliope.shuffle


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   calliope.shuffle.shuffle



.. py:function:: shuffle(playlist, count = None)

   Simple playlist shuffle.

   This randomises the order of the items in the playlist.

   There is a lot more involved in creating "good" shuffled playlists. For
   example see https://labs.spotify.com/2014/02/28/how-to-shuffle-songs/

   :param playlist: Input playlist.
   :param count: Maximum number of items in the output playlist (default: unlimited).

   :returns: A playlist.