Package pyechonest :: Module sandbox
[hide private]
[frames] | no frames]

Module sandbox

source code

Copyright (c) 2010 The Echo Nest. All rights reserved. Created by Tyler Williams on 2011-10-21.

The Sandbox module loosely covers http://developer.echonest.com/docs/v4/sandbox.html Refer to the official api documentation if you are unsure about something.

Functions [hide private]
 
list(sandbox_name, results=15, start=0)
Returns a list of all assets available in this sandbox
source code
 
access(sandbox_name, asset_ids)
Returns a list of assets with expiring access urls that can be used to download them Requires Oauth
source code
Variables [hide private]
  __package__ = 'pyechonest'
Function Details [hide private]

list(sandbox_name, results=15, start=0)

source code 

Returns a list of all assets available in this sandbox

Args:
sandbox_name (str): A string representing the name of the sandbox
Kwargs:

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

start (int): An integer starting value for the result set

Returns:
A list of asset dictionaries

Example:

>>> sandbox.list('bluenote')
[{}, {}]
>>>

access(sandbox_name, asset_ids)

source code 

Returns a list of assets with expiring access urls that can be used to download them Requires Oauth

Args:
sandbox_name (str): A string representing the name of the sandbox asset_ids (list): A list of asset_ids (str) to fetch

Kwargs:

Returns:
A list of asset dictionaries

Example:

>>> sandbox.access('bluenote', ['12345'])
[{}, {}]
>>>