Playlist – playlist methods¶

class pyechonest.playlist.Playlist(session_id=None, type=None, artist_pick=None, variety=None, artist_id=None, artist=None, song_id=None, track_id=None, description=None, style=None, mood=None, max_tempo=None, min_tempo=None, max_duration=None, min_duration=None, max_loudness=None, min_loudness=None, max_danceability=None, min_danceability=None, max_energy=None, min_energy=None, artist_max_familiarity=None, artist_min_familiarity=None, artist_max_hotttnesss=None, artist_min_hotttnesss=None, song_max_hotttnesss=None, song_min_hotttnesss=None, min_longitude=None, max_longitude=None, min_latitude=None, max_latitude=None, adventurousness=None, mode=None, key=None, buckets=None, sort=None, limit=False, seed_catalog=None, source_catalog=None, rank_type=None, test_new_things=None, artist_start_year_after=None, artist_start_year_before=None, artist_end_year_after=None, artist_end_year_before=None, dmca=False, distribution=None, song_type=None, session_catalog=None, genres=None)¶

A Dynamic Playlist object. http://developer.echonest.com/docs/v4/playlist.html#dynamic-create

Attributes:

Example:

__init__(session_id=None, type=None, artist_pick=None, variety=None, artist_id=None, artist=None, song_id=None, track_id=None, description=None, style=None, mood=None, max_tempo=None, min_tempo=None, max_duration=None, min_duration=None, max_loudness=None, min_loudness=None, max_danceability=None, min_danceability=None, max_energy=None, min_energy=None, artist_max_familiarity=None, artist_min_familiarity=None, artist_max_hotttnesss=None, artist_min_hotttnesss=None, song_max_hotttnesss=None, song_min_hotttnesss=None, min_longitude=None, max_longitude=None, min_latitude=None, max_latitude=None, adventurousness=None, mode=None, key=None, buckets=None, sort=None, limit=False, seed_catalog=None, source_catalog=None, rank_type=None, test_new_things=None, artist_start_year_after=None, artist_start_year_before=None, artist_end_year_after=None, artist_end_year_before=None, dmca=False, distribution=None, song_type=None, session_catalog=None, genres=None)¶

__repr__()¶

delete()¶

feedback(ban_artist=None, ban_song=None, skip_song=None, favorite_artist=None, favorite_song=None, play_song=None, unplay_song=None, rate_song=None, invalidate_song=None, invalidate_artist=None)¶

get_current_songs()¶

get_lookahead_songs()¶

get_next_songs(results=None, lookahead=None)¶

info()¶

restart(type=None, artist_pick=None, variety=None, artist_id=None, artist=None, song_id=None, track_id=None, description=None, style=None, mood=None, max_tempo=None, min_tempo=None, max_duration=None, min_duration=None, max_loudness=None, min_loudness=None, max_danceability=None, min_danceability=None, max_energy=None, min_energy=None, artist_max_familiarity=None, artist_min_familiarity=None, artist_max_hotttnesss=None, artist_min_hotttnesss=None, song_max_hotttnesss=None, song_min_hotttnesss=None, min_longitude=None, max_longitude=None, min_latitude=None, max_latitude=None, adventurousness=None, mode=None, key=None, buckets=None, sort=None, limit=False, seed_catalog=None, source_catalog=None, rank_type=None, test_new_things=None, artist_start_year_after=None, artist_start_year_before=None, artist_end_year_after=None, artist_end_year_before=None, dmca=False, distribution=None, song_type=None, genres=None)¶

steer(max_tempo=None, min_tempo=None, target_tempo=None, max_duration=None, min_duration=None, target_duration=None, max_loudness=None, min_loudness=None, target_loudness=None, max_danceability=None, min_danceability=None, target_danceability=None, max_energy=None, min_energy=None, target_energy=None, max_artist_familiarity=None, min_artist_familiarity=None, target_artist_familiarity=None, max_artist_hotttnesss=None, min_artist_hotttnesss=None, target_artist_hotttnesss=None, max_song_hotttnesss=None, min_song_hotttnesss=None, target_song_hotttnesss=None, more_like_this=None, less_like_this=None, adventurousness=None, variety=None, description=None, style=None, mood=None, song_type=None, genres=None)¶

static playlist.basic(type='artist-radio', artist_id=None, artist=None, song_id=None, song=None, track_id=None, dmca=False, results=15, buckets=None, limit=False, genres=None)¶

Get a basic playlist

Args:

Kwargs:

type (str): a string representing the playlist type (‘artist-radio’ or ‘song-radio’)

artist_id (str): the artist_id to seed the playlist

artist (str): the name of an artist to seed the playlist

song_id (str): a song_id to seed the playlist

song (str): the name of a song to seed the playlist

track_id (str): the name of a track to seed the playlist

dmca (bool): make the playlist dmca-compliant

results (int): desired length of the playlist

buckets (list): A list of strings specifying which buckets to retrieve

limit (bool): Whether results should be restricted to any idspaces given in the buckets parameter

static playlist.static(type='artist', artist_pick='song_hotttnesss-desc', variety=0.5, artist_id=None, artist=None, song_id=None, track_id=None, description=None, style=None, mood=None, results=15, max_tempo=None, min_tempo=None, max_duration=None, min_duration=None, max_loudness=None, min_loudness=None, max_danceability=None, min_danceability=None, max_energy=None, min_energy=None, artist_max_familiarity=None, artist_min_familiarity=None, artist_max_hotttnesss=None, artist_min_hotttnesss=None, song_max_hotttnesss=None, song_min_hotttnesss=None, min_longitude=None, max_longitude=None, min_latitude=None, max_latitude=None, adventurousness=0.20000000000000001, mode=None, key=None, buckets=None, sort=None, limit=False, seed_catalog=None, source_catalog=None, rank_type=None, test_new_things=None, artist_start_year_after=None, artist_start_year_before=None, artist_end_year_after=None, artist_end_year_before=None, dmca=False, distribution=None, song_type=None, genres=None)¶

Get a static playlist

Args:

Kwargs:

type (str): a string representing the playlist type (‘artist’, ‘artist-radio’, ...)

artist_pick (str): How songs should be chosen for each artist

variety (float): A number between 0 and 1 specifying the variety of the playlist

artist_id (str): the artist_id

artist (str): the name of an artist

song_id (str): the song_id

track_id (str): the track id

description (str): A string describing the artist and song

style (str): A string describing the style/genre of the artist and song

mood (str): A string describing the mood of the artist and song

results (int): An integer number of results to return

max_tempo (float): The max tempo of song results

min_tempo (float): The min tempo of song results

max_duration (float): The max duration of song results

min_duration (float): The min duration of song results

max_loudness (float): The max loudness of song results

min_loudness (float): The min loudness of song results

artist_max_familiarity (float): A float specifying the max familiarity of artists to search for

artist_min_familiarity (float): A float specifying the min familiarity of artists to search for

artist_max_hotttnesss (float): A float specifying the max hotttnesss of artists to search for

artist_min_hotttnesss (float): A float specifying the max hotttnesss of artists to search for

song_max_hotttnesss (float): A float specifying the max hotttnesss of songs to search for

song_min_hotttnesss (float): A float specifying the max hotttnesss of songs to search for

max_energy (float): The max energy of song results

min_energy (float): The min energy of song results

max_danceability (float): The max danceability of song results

min_danceability (float): The min danceability of song results

mode (int): 0 or 1 (minor or major)

key (int): 0-11 (c, c-sharp, d, e-flat, e, f, f-sharp, g, a-flat, a, b-flat, b)

max_latitude (float): A float specifying the max latitude of artists to search for

min_latitude (float): A float specifying the min latitude of artists to search for

max_longitude (float): A float specifying the max longitude of artists to search for

min_longitude (float): A float specifying the min longitude of artists to search for

adventurousness (float): A float ranging from 0 for old favorites to 1.0 for unheard music according to a seed_catalog

sort (str): A string indicating an attribute and order for sorting the results

buckets (list): A list of strings specifying which buckets to retrieve

limit (bool): A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets

seed_catalog (str or Catalog): An Artist Catalog object or Artist Catalog id to use as a seed

source_catalog (str or Catalog): A Catalog object or catalog id

rank_type (str): A string denoting the desired ranking for description searches, either ‘relevance’ or ‘familiarity’

artist_start_year_before (int): Returned song’s artists will have started recording music before this year.

artist_start_year_after (int): Returned song’s artists will have started recording music after this year.

artist_end_year_before (int): Returned song’s artists will have stopped recording music before this year.

artist_end_year_after (int): Returned song’s artists will have stopped recording music after this year.

distribution (str): Affects the range of artists returned and how many songs each artist will have in the playlist relative to how similar they are to the seed. (wandering, focused)

song_type (str): A string or list of strings of the type of songs allowed. The only valid song type at the moment is ‘christmas’.: Valid formats are ‘song_type’, ‘song_type:true’, ‘song_type:false’, or ‘song_type:any’.

Returns:

A list of Song objects

Example:

>>> p = playlist.static(type='artist-radio', artist=['ida maria', 'florence + the machine'])
>>> p
[<song - Pickpocket>,
 <song - Self-Taught Learner>,
 <song - Maps>,
 <song - Window Blues>,
 <song - That's Not My Name>,
 <song - My Lover Will Go>,
 <song - Home Sweet Home>,
 <song - Stella & God>,
 <song - Don't You Want To Share The Guilt?>,
 <song - Forget About It>,
 <song - Dull Life>,
 <song - This Trumpet In My Head>,
 <song - Keep Your Head>,
 <song - One More Time>,
 <song - Knights in Mountain Fox Jackets>]
>>> 

class pyechonest.playlist.DeprecatedPlaylist(session_id=None, type='artist', artist_pick='song_hotttnesss-desc', variety=0.5, artist_id=None, artist=None, song_id=None, track_id=None, description=None, style=None, mood=None, max_tempo=None, min_tempo=None, max_duration=None, min_duration=None, max_loudness=None, min_loudness=None, max_danceability=None, min_danceability=None, max_energy=None, min_energy=None, artist_max_familiarity=None, artist_min_familiarity=None, artist_max_hotttnesss=None, artist_min_hotttnesss=None, song_max_hotttnesss=None, song_min_hotttnesss=None, min_longitude=None, max_longitude=None, min_latitude=None, max_latitude=None, adventurousness=0.20000000000000001, mode=None, key=None, buckets=None, sort=None, limit=False, dmca=False, chain_xspf=False, seed_catalog=None, steer=None, source_catalog=None, steer_description=None, test_new_things=None, rank_type=None, artist_start_year_after=None, artist_start_year_before=None, artist_end_year_after=None, artist_end_year_before=None)¶

A Deprecated Dynamic Playlist object

Attributes:

session_id (str): Playlist Session ID

song (song object): The current song

info (dictionary): Information about this playlist

Example:

>>> p = DeprecatedPlaylist(type='artist-radio', artist=['ida maria', 'florence + the machine'])
>>> p
<Deprecated Dynamic Playlist - 9c210205d4784144b4fa90770fa55d0b>
>>> p.song
<song - Later On>
>>> p.get_next_song()
<song - Overall>
>>> 

__init__(session_id=None, type='artist', artist_pick='song_hotttnesss-desc', variety=0.5, artist_id=None, artist=None, song_id=None, track_id=None, description=None, style=None, mood=None, max_tempo=None, min_tempo=None, max_duration=None, min_duration=None, max_loudness=None, min_loudness=None, max_danceability=None, min_danceability=None, max_energy=None, min_energy=None, artist_max_familiarity=None, artist_min_familiarity=None, artist_max_hotttnesss=None, artist_min_hotttnesss=None, song_max_hotttnesss=None, song_min_hotttnesss=None, min_longitude=None, max_longitude=None, min_latitude=None, max_latitude=None, adventurousness=0.20000000000000001, mode=None, key=None, buckets=None, sort=None, limit=False, dmca=False, chain_xspf=False, seed_catalog=None, steer=None, source_catalog=None, steer_description=None, test_new_things=None, rank_type=None, artist_start_year_after=None, artist_start_year_before=None, artist_end_year_after=None, artist_end_year_before=None)¶

Args:

Kwargs:

type (str): a string representing the playlist type (‘artist’, ‘artist-radio’, ...)

artist_pick (str): How songs should be chosen for each artist

variety (float): A number between 0 and 1 specifying the variety of the playlist

artist_id (str): the artist_id

artist (str): the name of an artist

song_id (str): the song_id

track_id (str): the track_id