/src/pyechonest/doc/build/html/artist.html
HTML | 678 lines | 647 code | 31 blank | 0 comment | 0 complexity | 6ef40cdc5479da17c2e2703219b9a303 MD5 | raw file
1 2 3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 6<html xmlns="http://www.w3.org/1999/xhtml"> 7 <head> 8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 <title>Artist artist methods — pyechonest v4 documentation</title> 11 <link rel="stylesheet" href="_static/default.css" type="text/css" /> 12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> 13 <script type="text/javascript"> 14 var DOCUMENTATION_OPTIONS = { 15 URL_ROOT: '', 16 VERSION: '4', 17 COLLAPSE_INDEX: false, 18 FILE_SUFFIX: '.html', 19 HAS_SOURCE: true 20 }; 21 </script> 22 <script type="text/javascript" src="_static/jquery.js"></script> 23 <script type="text/javascript" src="_static/underscore.js"></script> 24 <script type="text/javascript" src="_static/doctools.js"></script> 25 <link rel="top" title="pyechonest v4 documentation" href="index.html" /> 26 <link rel="next" title="Song song methods" href="song.html" /> 27 <link rel="prev" title="Welcome to pyechonests documentation!" href="index.html" /> 28 </head> 29 <body> 30 <div class="related"> 31 <h3>Navigation</h3> 32 <ul> 33 <li class="right" style="margin-right: 10px"> 34 <a href="genindex.html" title="General Index" 35 accesskey="I">index</a></li> 36 <li class="right" > 37 <a href="py-modindex.html" title="Python Module Index" 38 >modules</a> |</li> 39 <li class="right" > 40 <a href="song.html" title="Song song methods" 41 accesskey="N">next</a> |</li> 42 <li class="right" > 43 <a href="index.html" title="Welcome to pyechonests documentation!" 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html">pyechonest v4 documentation</a> »</li> 46 </ul> 47 </div> 48 49 <div class="document"> 50 <div class="documentwrapper"> 51 <div class="bodywrapper"> 52 <div class="body"> 53 54 <div class="section" id="artist-artist-methods"> 55<h1>Artist – artist methods<a class="headerlink" href="#artist-artist-methods" title="Permalink to this headline">ś</a></h1> 56<dl class="class"> 57<dt id="pyechonest.artist.Artist"> 58<em class="property">class </em><tt class="descclassname">pyechonest.artist.</tt><tt class="descname">Artist</tt><big>(</big><em>id</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist" title="Permalink to this definition">ś</a></dt> 59<dd><p>An Artist object</p> 60<dl class="docutils"> 61<dt>Attributes: </dt> 62<dd><p class="first">id (str): Echo Nest Artist ID</p> 63<p>name (str): Artist Name</p> 64<p>audio (list): Artist audio</p> 65<p>biographies (list): Artist biographies</p> 66<p>blogs (list): Artist blogs</p> 67<p>familiarity (float): Artist familiarity</p> 68<p>hotttnesss (float): Artist hotttnesss</p> 69<p>images (list): Artist images</p> 70<p>news (list): Artist news</p> 71<p>reviews (list): Artist reviews</p> 72<p>similar (list): Similar Artists</p> 73<p>songs (list): A list of song objects</p> 74<p>terms (list): Terms for an artist</p> 75<p>urls (list): Artist urls</p> 76<p class="last">video (list): Artist video</p> 77</dd> 78</dl> 79<p>You create an artist object like this:</p> 80<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'ARH6W4X1187B99274F'</span><span class="p">)</span> 81<span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'the national'</span><span class="p">)</span> 82<span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'musicbrainz:artist:a74b1b7f-71a5-4011-9441-d0b5e4122711'</span><span class="p">)</span> 83</pre></div> 84</div> 85<dl class="method"> 86<dt id="pyechonest.artist.Artist.__cmp__"> 87<tt class="descname">__cmp__</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.__cmp__" title="Permalink to this definition">ś</a></dt> 88<dd></dd></dl> 89 90<dl class="method"> 91<dt id="pyechonest.artist.Artist.__init__"> 92<tt class="descname">__init__</tt><big>(</big><em>id</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.__init__" title="Permalink to this definition">ś</a></dt> 93<dd><p>Artist class</p> 94<dl class="docutils"> 95<dt>Args:</dt> 96<dd>id (str): an artistw ID</dd> 97<dt>Returns:</dt> 98<dd>An artist object</dd> 99</dl> 100<p>Example:</p> 101<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'ARH6W4X1187B99274F'</span><span class="p">,</span> <span class="n">buckets</span><span class="o">=</span><span class="p">[</span><span class="s">'hotttnesss'</span><span class="p">])</span> 102<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">hotttnesss</span> 103<span class="go">0.80098515900997658</span> 104<span class="go">>>></span> 105</pre></div> 106</div> 107</dd></dl> 108 109<dl class="method"> 110<dt id="pyechonest.artist.Artist.__repr__"> 111<tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.__repr__" title="Permalink to this definition">ś</a></dt> 112<dd></dd></dl> 113 114<dl class="method"> 115<dt id="pyechonest.artist.Artist.__str__"> 116<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.__str__" title="Permalink to this definition">ś</a></dt> 117<dd></dd></dl> 118 119<dl class="method"> 120<dt id="pyechonest.artist.Artist.get_audio"> 121<tt class="descname">get_audio</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_audio" title="Permalink to this definition">ś</a></dt> 122<dd><p>Get a list of audio documents found on the web related to an artist</p> 123<p>Args:</p> 124<dl class="docutils"> 125<dt>Kwargs:</dt> 126<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 127<p>results (int): An integer number of results to return</p> 128<p class="last">start (int): An integer starting value for the result set</p> 129</dd> 130<dt>Returns:</dt> 131<dd>A list of audio document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 132</dl> 133<p>Example:</p> 134<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'alphabeat'</span><span class="p">)</span> 135<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_audio</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> 136<span class="go">{u'artist': u'Alphabeat',</span> 137<span class="go"> u'date': u'2010-04-28T01:40:45',</span> 138<span class="go"> u'id': u'70be4373fa57ac2eee8c7f30b0580899',</span> 139<span class="go"> u'length': 210.0,</span> 140<span class="go"> u'link': u'http://iamthecrime.com',</span> 141<span class="go"> u'release': u'The Beat Is...',</span> 142<span class="go"> u'title': u'DJ',</span> 143<span class="go"> u'url': u'http://iamthecrime.com/wp-content/uploads/2010/04/03_DJ_iatc.mp3'}</span> 144<span class="gp">>>> </span> 145</pre></div> 146</div> 147</dd></dl> 148 149<dl class="method"> 150<dt id="pyechonest.artist.Artist.get_biographies"> 151<tt class="descname">get_biographies</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>license=None</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_biographies" title="Permalink to this definition">ś</a></dt> 152<dd><p>Get a list of artist biographies</p> 153<p>Args:</p> 154<dl class="docutils"> 155<dt>Kwargs:</dt> 156<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 157<p>results (int): An integer number of results to return</p> 158<p>start (int): An integer starting value for the result set</p> 159<p class="last">license (str): A string specifying the desired license type</p> 160</dd> 161<dt>Returns:</dt> 162<dd>A list of biography document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 163</dl> 164<p>Example:</p> 165<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'britney spears'</span><span class="p">)</span> 166<span class="gp">>>> </span><span class="n">bio</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">get_biographies</span><span class="p">(</span><span class="n">results</span><span class="o">=</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> 167<span class="gp">>>> </span><span class="n">bio</span><span class="p">[</span><span class="s">'url'</span><span class="p">]</span> 168<span class="go">u'http://www.mtvmusic.com/spears_britney'</span> 169<span class="gp">>>> </span> 170</pre></div> 171</div> 172</dd></dl> 173 174<dl class="method"> 175<dt id="pyechonest.artist.Artist.get_blogs"> 176<tt class="descname">get_blogs</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>cache=True</em>, <em>high_relevance=False</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_blogs" title="Permalink to this definition">ś</a></dt> 177<dd><p>Get a list of blog articles related to an artist</p> 178<p>Args:</p> 179<dl class="docutils"> 180<dt>Kwargs:</dt> 181<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 182<p>results (int): An integer number of results to return</p> 183<p class="last">start (int): An ingteger starting value for the result set</p> 184</dd> 185<dt>Returns:</dt> 186<dd>A list of blog document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 187</dl> 188<p>Example:</p> 189<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'bob marley'</span><span class="p">)</span> 190<span class="gp">>>> </span><span class="n">blogs</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">get_blogs</span><span class="p">(</span><span class="n">results</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span><span class="n">start</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> 191<span class="gp">>>> </span><span class="n">blogs</span><span class="o">.</span><span class="n">total</span> 192<span class="go">4068</span> 193<span class="gp">>>> </span><span class="n">blogs</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s">'summary'</span><span class="p">]</span> 194<span class="go">But the Kenyans I know relate to music about the same way Americans do. They like their Congolese afropop, </span> 195<span class="go">and I've known some to be big fans of international acts like <span>Bob</span> <span>Marley</span> and Dolly Parton. </span> 196<span class="go">They rarely talk about music that's indigenous in the way a South African or Malian or Zimbabwean would, and it's </span> 197<span class="go">even rarer to actually hear such indigenous music. I do sometimes hear ceremonial chanting from the Maasai, but only </span> 198<span class="go">when they're dancing for tourists. If East Africa isn't the most musical part ... "</span> 199<span class="gp">>>> </span> 200</pre></div> 201</div> 202</dd></dl> 203 204<dl class="method"> 205<dt id="pyechonest.artist.Artist.get_familiarity"> 206<tt class="descname">get_familiarity</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_familiarity" title="Permalink to this definition">ś</a></dt> 207<dd><p>Get our numerical estimation of how familiar an artist currently is to the world</p> 208<p>Args:</p> 209<dl class="docutils"> 210<dt>Kwargs:</dt> 211<dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd> 212<dt>Returns:</dt> 213<dd>A float representing familiarity.</dd> 214</dl> 215<p>Example:</p> 216<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'frank sinatra'</span><span class="p">)</span> 217<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_familiarity</span><span class="p">()</span> 218<span class="go">0.65142555825947457</span> 219<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">familiarity</span> 220<span class="go">0.65142555825947457</span> 221<span class="go">>>></span> 222</pre></div> 223</div> 224</dd></dl> 225 226<dl class="method"> 227<dt id="pyechonest.artist.Artist.get_foreign_id"> 228<tt class="descname">get_foreign_id</tt><big>(</big><em>idspace='musicbrainz'</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_foreign_id" title="Permalink to this definition">ś</a></dt> 229<dd><p>Get the foreign id for this artist for a specific id space</p> 230<p>Args:</p> 231<dl class="docutils"> 232<dt>Kwargs:</dt> 233<dd>idspace (str): A string indicating the idspace to fetch a foreign id for.</dd> 234<dt>Returns:</dt> 235<dd>A foreign ID string</dd> 236</dl> 237<p>Example:</p> 238<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'fabulous'</span><span class="p">)</span> 239<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_foreign_id</span><span class="p">(</span><span class="s">'7digital'</span><span class="p">)</span> 240<span class="go">u'7digital:artist:186042'</span> 241<span class="gp">>>> </span> 242</pre></div> 243</div> 244</dd></dl> 245 246<dl class="method"> 247<dt id="pyechonest.artist.Artist.get_hotttnesss"> 248<tt class="descname">get_hotttnesss</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_hotttnesss" title="Permalink to this definition">ś</a></dt> 249<dd><p>Get our numerical description of how hottt an artist currently is</p> 250<p>Args:</p> 251<dl class="docutils"> 252<dt>Kwargs:</dt> 253<dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd> 254<dt>Returns:</dt> 255<dd>float: the hotttnesss value</dd> 256</dl> 257<p>Example:</p> 258<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'hannah montana'</span><span class="p">)</span> 259<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_hotttnesss</span><span class="p">()</span> 260<span class="go">0.59906022155998995</span> 261<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">hotttnesss</span> 262<span class="go">0.59906022155998995</span> 263<span class="go">>>></span> 264</pre></div> 265</div> 266</dd></dl> 267 268<dl class="method"> 269<dt id="pyechonest.artist.Artist.get_images"> 270<tt class="descname">get_images</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>license=None</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_images" title="Permalink to this definition">ś</a></dt> 271<dd><p>Get a list of artist images</p> 272<dl class="docutils"> 273<dt>Args:</dt> 274<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 275<p>results (int): An integer number of results to return</p> 276<p>start (int): An integer starting value for the result set</p> 277<p class="last">license (str): A string specifying the desired license type</p> 278</dd> 279<dt>Returns:</dt> 280<dd>A list of image document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 281</dl> 282<p>Example:</p> 283<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'Captain Beefheart'</span><span class="p">)</span> 284<span class="gp">>>> </span><span class="n">images</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">get_images</span><span class="p">(</span><span class="n">results</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> 285<span class="gp">>>> </span><span class="n">images</span><span class="o">.</span><span class="n">total</span> 286<span class="go">49</span> 287<span class="gp">>>> </span><span class="n">images</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s">'url'</span><span class="p">]</span> 288<span class="go">u'http://c4.ac-images.myspacecdn.com/images01/5/l_e1a329cdfdb16a848288edc6d578730f.jpg'</span> 289<span class="gp">>>> </span> 290</pre></div> 291</div> 292</dd></dl> 293 294<dl class="method"> 295<dt id="pyechonest.artist.Artist.get_news"> 296<tt class="descname">get_news</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>cache=True</em>, <em>high_relevance=False</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_news" title="Permalink to this definition">ś</a></dt> 297<dd><p>Get a list of news articles found on the web related to an artist</p> 298<dl class="docutils"> 299<dt>Args:</dt> 300<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 301<p>results (int): An integer number of results to return</p> 302<p class="last">start (int): An integer starting value for the result set</p> 303</dd> 304<dt>Returns:</dt> 305<dd>A list of news document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 306</dl> 307<p>Example:</p> 308<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'Henry Threadgill'</span><span class="p">)</span> 309<span class="gp">>>> </span><span class="n">news</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">news</span> 310<span class="gp">>>> </span><span class="n">news</span><span class="o">.</span><span class="n">total</span> 311<span class="go">41</span> 312<span class="gp">>>> </span><span class="n">news</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s">'name'</span><span class="p">]</span> 313<span class="go">u'Jazz Journalists Association Announces 2010 Jazz Award Winners'</span> 314<span class="gp">>>> </span> 315</pre></div> 316</div> 317</dd></dl> 318 319<dl class="method"> 320<dt id="pyechonest.artist.Artist.get_reviews"> 321<tt class="descname">get_reviews</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_reviews" title="Permalink to this definition">ś</a></dt> 322<dd><p>Get reviews related to an artist’s work</p> 323<p>Args:</p> 324<dl class="docutils"> 325<dt>Kwargs:</dt> 326<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 327<p>results (int): An integer number of results to return</p> 328<p class="last">start (int): An integer starting value for the result set</p> 329</dd> 330<dt>Returns:</dt> 331<dd>A list of review document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 332</dl> 333<p>Example:</p> 334<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'Ennio Morricone'</span><span class="p">)</span> 335<span class="gp">>>> </span><span class="n">reviews</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">reviews</span> 336<span class="gp">>>> </span><span class="n">reviews</span><span class="o">.</span><span class="n">total</span> 337<span class="go">17</span> 338<span class="gp">>>> </span><span class="n">reviews</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s">'release'</span><span class="p">]</span> 339<span class="go">u'For A Few Dollars More'</span> 340<span class="gp">>>> </span> 341</pre></div> 342</div> 343</dd></dl> 344 345<dl class="method"> 346<dt id="pyechonest.artist.Artist.get_similar"> 347<tt class="descname">get_similar</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>buckets=None</em>, <em>limit=False</em>, <em>cache=True</em>, <em>max_familiarity=None</em>, <em>min_familiarity=None</em>, <em>max_hotttnesss=None</em>, <em>min_hotttnesss=None</em>, <em>min_results=None</em>, <em>reverse=False</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_similar" title="Permalink to this definition">ś</a></dt> 348<dd><p>Return similar artists to this one</p> 349<p>Args:</p> 350<dl class="docutils"> 351<dt>Kwargs:</dt> 352<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 353<p>results (int): An integer number of results to return</p> 354<p>start (int): An integer starting value for the result set</p> 355<p>max_familiarity (float): A float specifying the max familiarity of artists to search for</p> 356<p>min_familiarity (float): A float specifying the min familiarity of artists to search for</p> 357<p>max_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p> 358<p>min_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p> 359<p class="last">reverse (bool): A boolean indicating whether or not to return dissimilar artists (wrecommender). Defaults to False.</p> 360</dd> 361<dt>Returns:</dt> 362<dd>A list of similar Artist objects</dd> 363</dl> 364<p>Example:</p> 365<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'Sleater Kinney'</span><span class="p">)</span> 366<span class="gp">>>> </span><span class="n">similars</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">similar</span><span class="p">[:</span><span class="mi">5</span><span class="p">]</span> 367<span class="gp">>>> </span><span class="n">similars</span> 368<span class="go">[<artist - Bikini Kill>, <artist - Pretty Girls Make Graves>, <artist - Huggy Bear>, <artist - Bratmobile>, <artist - Team Dresch>]</span> 369<span class="gp">>>> </span> 370</pre></div> 371</div> 372</dd></dl> 373 374<dl class="method"> 375<dt id="pyechonest.artist.Artist.get_songs"> 376<tt class="descname">get_songs</tt><big>(</big><em>cache=True</em>, <em>results=15</em>, <em>start=0</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_songs" title="Permalink to this definition">ś</a></dt> 377<dd><p>Get the songs associated with an artist</p> 378<p>Args:</p> 379<dl class="docutils"> 380<dt>Kwargs:</dt> 381<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 382<p>results (int): An integer number of results to return</p> 383<p class="last">start (int): An integer starting value for the result set</p> 384</dd> 385<dt>Results:</dt> 386<dd>A list of Song objects; list contains additional attributes ‘start’ and ‘total’</dd> 387</dl> 388<p>Example:</p> 389<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'Strokes'</span><span class="p">)</span> 390<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_songs</span><span class="p">(</span><span class="n">results</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> 391<span class="go">[<song - Fear Of Sleep>, <song - Red Light>, <song - Ize Of The World>, <song - Evening Sun>, <song - Juicebox>]</span> 392<span class="gp">>>> </span> 393</pre></div> 394</div> 395</dd></dl> 396 397<dl class="method"> 398<dt id="pyechonest.artist.Artist.get_terms"> 399<tt class="descname">get_terms</tt><big>(</big><em>sort='weight'</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_terms" title="Permalink to this definition">ś</a></dt> 400<dd><p>Get the terms associated with an artist</p> 401<p>Args:</p> 402<dl class="docutils"> 403<dt>Kwargs:</dt> 404<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 405<p class="last">sort (str): A string specifying the desired sorting type (weight or frequency)</p> 406</dd> 407<dt>Results:</dt> 408<dd>A list of term document dicts</dd> 409</dl> 410<p>Example:</p> 411<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'tom petty'</span><span class="p">)</span> 412<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">terms</span> 413<span class="go">[{u'frequency': 1.0, u'name': u'heartland rock', u'weight': 1.0},</span> 414<span class="go"> {u'frequency': 0.88569401860168606,</span> 415<span class="go"> u'name': u'jam band',</span> 416<span class="go"> u'weight': 0.9116501862732439},</span> 417<span class="go"> {u'frequency': 0.9656145118557401,</span> 418<span class="go"> u'name': u'pop rock',</span> 419<span class="go"> u'weight': 0.89777934440040685},</span> 420<span class="go"> {u'frequency': 0.8414744288140491,</span> 421<span class="go"> u'name': u'southern rock',</span> 422<span class="go"> u'weight': 0.8698567153186606},</span> 423<span class="go"> {u'frequency': 0.9656145118557401,</span> 424<span class="go"> u'name': u'hard rock',</span> 425<span class="go"> u'weight': 0.85738022655218893},</span> 426<span class="go"> {u'frequency': 0.88569401860168606,</span> 427<span class="go"> u'name': u'singer-songwriter',</span> 428<span class="go"> u'weight': 0.77427243392312772},</span> 429<span class="go"> {u'frequency': 0.88569401860168606,</span> 430<span class="go"> u'name': u'rock',</span> 431<span class="go"> u'weight': 0.71158718989399083},</span> 432<span class="go"> {u'frequency': 0.60874110500110956,</span> 433<span class="go"> u'name': u'album rock',</span> 434<span class="go"> u'weight': 0.69758668733499629},</span> 435<span class="go"> {u'frequency': 0.74350792060935744,</span> 436<span class="go"> u'name': u'psychedelic',</span> 437<span class="go"> u'weight': 0.68457367494207944},</span> 438<span class="go"> {u'frequency': 0.77213698386292873,</span> 439<span class="go"> u'name': u'pop',</span> 440<span class="go"> u'weight': 0.65039556639337293},</span> 441<span class="go"> {u'frequency': 0.41747136183050298,</span> 442<span class="go"> u'name': u'bar band',</span> 443<span class="go"> u'weight': 0.54974975024767025}]</span> 444<span class="gp">>>> </span> 445</pre></div> 446</div> 447</dd></dl> 448 449<dl class="method"> 450<dt id="pyechonest.artist.Artist.get_urls"> 451<tt class="descname">get_urls</tt><big>(</big><em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_urls" title="Permalink to this definition">ś</a></dt> 452<dd><p>Get the urls for an artist</p> 453<p>Args:</p> 454<dl class="docutils"> 455<dt>Kwargs:</dt> 456<dd>cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</dd> 457<dt>Results:</dt> 458<dd>A url document dict</dd> 459</dl> 460<p>Example:</p> 461<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'the unicorns'</span><span class="p">)</span> 462<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_urls</span><span class="p">()</span> 463<span class="go">{u'amazon_url': u'http://www.amazon.com/gp/search?ie=UTF8&keywords=The Unicorns&tag=httpechonecom-20&index=music',</span> 464<span class="go"> u'aolmusic_url': u'http://music.aol.com/artist/the-unicorns',</span> 465<span class="go"> u'itunes_url': u'http://itunes.com/TheUnicorns',</span> 466<span class="go"> u'lastfm_url': u'http://www.last.fm/music/The+Unicorns',</span> 467<span class="go"> u'mb_url': u'http://musicbrainz.org/artist/603c5f9f-492a-4f21-9d6f-1642a5dbea2d.html',</span> 468<span class="go"> u'myspace_url': u'http://www.myspace.com/iwasbornunicorn'}</span> 469<span class="gp">>>> </span> 470</pre></div> 471</div> 472</dd></dl> 473 474<dl class="method"> 475<dt id="pyechonest.artist.Artist.get_video"> 476<tt class="descname">get_video</tt><big>(</big><em>results=15</em>, <em>start=0</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pyechonest.artist.Artist.get_video" title="Permalink to this definition">ś</a></dt> 477<dd><p>Get a list of video documents found on the web related to an artist</p> 478<p>Args:</p> 479<dl class="docutils"> 480<dt>Kwargs:</dt> 481<dd><p class="first">cache (bool): A boolean indicating whether or not the cached value should be used (if available). Defaults to True.</p> 482<p>results (int): An integer number of results to return</p> 483<p class="last">start (int): An integer starting value for the result set</p> 484</dd> 485<dt>Returns:</dt> 486<dd>A list of video document dicts; list contains additional attributes ‘start’ and ‘total’</dd> 487</dl> 488<p>Example:</p> 489<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'the vapors'</span><span class="p">)</span> 490<span class="gp">>>> </span><span class="n">a</span><span class="o">.</span><span class="n">get_video</span><span class="p">(</span><span class="n">results</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> 491<span class="go">[{u'date_found': u'2009-12-28T08:27:48',</span> 492<span class="go"> u'id': u'd02f9e6dc7904f70402d4676516286b9',</span> 493<span class="go"> u'image_url': u'http://i1.ytimg.com/vi/p6c0wOFL3Us/default.jpg',</span> 494<span class="go"> u'site': u'youtube',</span> 495<span class="go"> u'title': u'The Vapors-Turning Japanese (rectangular white vinyl promo)',</span> 496<span class="go"> u'url': u'http://youtube.com/watch?v=p6c0wOFL3Us'}]</span> 497<span class="gp">>>> </span> 498</pre></div> 499</div> 500</dd></dl> 501 502</dd></dl> 503 504<dl class="staticmethod"> 505<dt id="pyechonest.artist.search"> 506<em class="property">static </em><tt class="descclassname">artist.</tt><tt class="descname">search</tt><big>(</big><em>name=None</em>, <em>description=None</em>, <em>style=None</em>, <em>mood=None</em>, <em>results=15</em>, <em>buckets=None</em>, <em>limit=False</em>, <em>fuzzy_match=False</em>, <em>sort=None</em>, <em>max_familiarity=None</em>, <em>min_familiarity=None</em>, <em>max_hotttnesss=None</em>, <em>min_hotttnesss=None</em>, <em>test_new_things=None</em>, <em>rank_type=None</em><big>)</big><a class="headerlink" href="#pyechonest.artist.search" title="Permalink to this definition">ś</a></dt> 507<dd><p>Search for artists by name, description, or constraint.</p> 508<p>Args:</p> 509<dl class="docutils"> 510<dt>Kwargs:</dt> 511<dd><p class="first">name (str): the name of an artist</p> 512<p>description (str): A string describing the artist</p> 513<p>style (str): A string describing the style/genre of the artist</p> 514<p>mood (str): A string describing the mood of the artist</p> 515<p>results (int): An integer number of results to return</p> 516<p>buckets (list): A list of strings specifying which buckets to retrieve</p> 517<p>limit (bool): A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</p> 518<p>fuzzy_match (bool): A boolean indicating whether or not to search for similar sounding matches (only works with name)</p> 519<p>max_familiarity (float): A float specifying the max familiarity of artists to search for</p> 520<p>min_familiarity (float): A float specifying the min familiarity of artists to search for</p> 521<p>max_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p> 522<p>min_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p> 523<p class="last">rank_type (str): A string denoting the desired ranking for description searches, either ‘relevance’ or ‘familiarity’</p> 524</dd> 525<dt>Returns:</dt> 526<dd>A list of Artist objects</dd> 527</dl> 528<p>Example:</p> 529<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">results</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'t-pain'</span><span class="p">)</span> 530<span class="gp">>>> </span><span class="n">results</span> 531<span class="go">[<artist - T-Pain>, <artist - T-Pain & Lil Wayne>, <artist - T Pain & 2 Pistols>, <artist - Roscoe Dash & T-Pain>, <artist - Tony Moxberg & T-Pain>, <artist - Flo-Rida (feat. T-Pain)>, <artist - Shortyo/Too Short/T-Pain>]</span> 532<span class="gp">>>> </span> 533</pre></div> 534</div> 535</dd></dl> 536 537<dl class="staticmethod"> 538<dt id="pyechonest.artist.top_hottt"> 539<em class="property">static </em><tt class="descclassname">artist.</tt><tt class="descname">top_hottt</tt><big>(</big><em>start=0</em>, <em>results=15</em>, <em>buckets=None</em>, <em>limit=False</em><big>)</big><a class="headerlink" href="#pyechonest.artist.top_hottt" title="Permalink to this definition">ś</a></dt> 540<dd><p>Get the top hotttest artists, according to The Echo Nest</p> 541<p>Args:</p> 542<dl class="docutils"> 543<dt>Kwargs:</dt> 544<dd><p class="first">results (int): An integer number of results to return</p> 545<p>start (int): An integer starting value for the result set</p> 546<p>buckets (list): A list of strings specifying which buckets to retrieve</p> 547<p class="last">limit (bool): A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</p> 548</dd> 549<dt>Returns:</dt> 550<dd>A list of hottt Artist objects</dd> 551</dl> 552<p>Example:</p> 553<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">hot_stuff</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">top_hottt</span><span class="p">()</span> 554<span class="gp">>>> </span><span class="n">hot_stuff</span> 555<span class="go">[<artist - Deerhunter>, <artist - Sufjan Stevens>, <artist - Belle and Sebastian>, <artist - Glee Cast>, <artist - Linkin Park>, <artist - Neil Young>, <artist - Jimmy Eat World>, <artist - Kanye West>, <artist - Katy Perry>, <artist - Bruno Mars>, <artist - Lady Gaga>, <artist - Rihanna>, <artist - Lil Wayne>, <artist - Jason Mraz>, <artist - Green Day>]</span> 556<span class="gp">>>> </span> 557</pre></div> 558</div> 559</dd></dl> 560 561<dl class="staticmethod"> 562<dt id="pyechonest.artist.top_terms"> 563<em class="property">static </em><tt class="descclassname">artist.</tt><tt class="descname">top_terms</tt><big>(</big><em>results=15</em><big>)</big><a class="headerlink" href="#pyechonest.artist.top_terms" title="Permalink to this definition">ś</a></dt> 564<dd><p>Get a list of the top overall terms</p> 565<p>Args:</p> 566<dl class="docutils"> 567<dt>Kwargs:</dt> 568<dd>results (int): An integer number of results to return</dd> 569<dt>Returns:</dt> 570<dd>A list of term document dicts</dd> 571</dl> 572<p>Example:</p> 573<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">terms</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">top_terms</span><span class="p">(</span><span class="n">results</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> 574<span class="gp">>>> </span><span class="n">terms</span> 575<span class="go">[{u'frequency': 1.0, u'name': u'rock'},</span> 576<span class="go"> {u'frequency': 0.99054710039307992, u'name': u'electronic'},</span> 577<span class="go"> {u'frequency': 0.96131624654034398, u'name': u'hip hop'},</span> 578<span class="go"> {u'frequency': 0.94358477322411127, u'name': u'jazz'},</span> 579<span class="go"> {u'frequency': 0.94023302416455468, u'name': u'pop rock'}]</span> 580<span class="gp">>>> </span> 581</pre></div> 582</div> 583</dd></dl> 584 585<dl class="staticmethod"> 586<dt id="pyechonest.artist.similar"> 587<em class="property">static </em><tt class="descclassname">artist.</tt><tt class="descname">similar</tt><big>(</big><em>names=None</em>, <em>ids=None</em>, <em>start=0</em>, <em>results=15</em>, <em>buckets=None</em>, <em>limit=False</em>, <em>max_familiarity=None</em>, <em>min_familiarity=None</em>, <em>max_hotttnesss=None</em>, <em>min_hotttnesss=None</em>, <em>seed_catalog=None</em><big>)</big><a class="headerlink" href="#pyechonest.artist.similar" title="Permalink to this definition">ś</a></dt> 588<dd><p>Return similar artists to this one</p> 589<p>Args:</p> 590<dl class="docutils"> 591<dt>Kwargs:</dt> 592<dd><p class="first">ids (str/list): An artist id or list of ids</p> 593<p>names (str/list): An artist name or list of names</p> 594<p>results (int): An integer number of results to return</p> 595<p>buckets (list): A list of strings specifying which buckets to retrieve</p> 596<p>limit (bool): A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</p> 597<p>start (int): An integer starting value for the result set</p> 598<p>max_familiarity (float): A float specifying the max familiarity of artists to search for</p> 599<p>min_familiarity (float): A float specifying the min familiarity of artists to search for</p> 600<p>max_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p> 601<p>min_hotttnesss (float): A float specifying the max hotttnesss of artists to search for</p> 602<p class="last">seed_catalog (str): A string specifying the catalog similar artists are restricted to</p> 603</dd> 604<dt>Returns:</dt> 605<dd>A list of similar Artist objects</dd> 606</dl> 607<p>Example:</p> 608<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">some_dudes</span> <span class="o">=</span> <span class="p">[</span><span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'weezer'</span><span class="p">),</span> <span class="n">artist</span><span class="o">.</span><span class="n">Artist</span><span class="p">(</span><span class="s">'radiohead'</span><span class="p">)]</span> 609<span class="gp">>>> </span><span class="n">some_dudes</span> 610<span class="go">[<artist - Weezer>, <artist - Radiohead>]</span> 611<span class="gp">>>> </span><span class="n">sims</span> <span class="o">=</span> <span class="n">artist</span><span class="o">.</span><span class="n">similar</span><span class="p">(</span><span class="n">ids</span><span class="o">=</span><span class="p">[</span><span class="n">art</span><span class="o">.</span><span class="n">id</span> <span class="k">for</span> <span class="n">art</span> <span class="ow">in</span> <span class="n">some_dudes</span><span class="p">],</span> <span class="n">results</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> 612<span class="gp">>>> </span><span class="n">sims</span> 613<span class="go">[<artist - The Smashing Pumpkins>, <artist - Biffy Clyro>, <artist - Death Cab for Cutie>, <artist - Jimmy Eat World>, <artist - Nerf Herder>]</span> 614<span class="gp">>>> </span> 615</pre></div> 616</div> 617</dd></dl> 618 619</div> 620 621 622 </div> 623 </div> 624 </div> 625 <div class="sphinxsidebar"> 626 <div class="sphinxsidebarwrapper"> 627 <h4>Previous topic</h4> 628 <p class="topless"><a href="index.html" 629 title="previous chapter">Welcome to pyechonest’s documentation!</a></p> 630 <h4>Next topic</h4> 631 <p class="topless"><a href="song.html" 632 title="next chapter">Song – song methods</a></p> 633 <h3>This Page</h3> 634 <ul class="this-page-menu"> 635 <li><a href="_sources/artist.txt" 636 rel="nofollow">Show Source</a></li> 637 </ul> 638<div id="searchbox" style="display: none"> 639 <h3>Quick search</h3> 640 <form class="search" action="search.html" method="get"> 641 <input type="text" name="q" size="18" /> 642 <input type="submit" value="Go" /> 643 <input type="hidden" name="check_keywords" value="yes" /> 644 <input type="hidden" name="area" value="default" /> 645 </form> 646 <p class="searchtip" style="font-size: 90%"> 647 Enter search terms or a module, class or function name. 648 </p> 649</div> 650<script type="text/javascript">$('#searchbox').show(0);</script> 651 </div> 652 </div> 653 <div class="clearer"></div> 654 </div> 655 <div class="related"> 656 <h3>Navigation</h3> 657 <ul> 658 <li class="right" style="margin-right: 10px"> 659 <a href="genindex.html" title="General Index" 660 >index</a></li> 661 <li class="right" > 662 <a href="py-modindex.html" title="Python Module Index" 663 >modules</a> |</li> 664 <li class="right" > 665 <a href="song.html" title="Song song methods" 666 >next</a> |</li> 667 <li class="right" > 668 <a href="index.html" title="Welcome to pyechonests documentation!" 669 >previous</a> |</li> 670 <li><a href="index.html">pyechonest v4 documentation</a> »</li> 671 </ul> 672 </div> 673 <div class="footer"> 674 © Copyright 2010, The Echo Nest. 675 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5. 676 </div> 677 </body> 678</html>