/src/pyechonest/doc/build/html/artist.html

http://echo-nest-remix.googlecode.com/ · HTML · 678 lines · 647 code · 31 blank · 0 comment · 0 complexity · 6ef40cdc5479da17c2e2703219b9a303 MD5 · raw file

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