PageRenderTime 86ms CodeModel.GetById 40ms app.highlight 22ms RepoModel.GetById 19ms app.codeStats 0ms

/apidocs/pyechonest.artist-module.html

http://echo-nest-remix.googlecode.com/
HTML | 436 lines | 390 code | 23 blank | 23 comment | 0 complexity | 7cb766459bdf350a34317f4f61ac23c6 MD5 | raw file
  1<?xml version="1.0" encoding="ascii"?>
  2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3          "DTD/xhtml1-transitional.dtd">
  4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5<head>
  6  <title>pyechonest.artist</title>
  7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8  <script type="text/javascript" src="epydoc.js"></script>
  9</head>
 10
 11<body bgcolor="white" text="black" link="blue" vlink="#204080"
 12      alink="#204080">
 13<!-- ==================== NAVIGATION BAR ==================== -->
 14<table class="navbar" border="0" width="100%" cellpadding="0"
 15       bgcolor="#a0c0ff" cellspacing="0">
 16  <tr valign="middle">
 17
 18  <!-- Tree link -->
 19      <th>&nbsp;&nbsp;&nbsp;<a
 20        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 21
 22  <!-- Index link -->
 23      <th>&nbsp;&nbsp;&nbsp;<a
 24        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 25
 26  <!-- Help link -->
 27      <th>&nbsp;&nbsp;&nbsp;<a
 28        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 29
 30  <!-- Project homepage -->
 31      <th class="navbar" align="right" width="100%">
 32        <table border="0" cellpadding="0" cellspacing="0">
 33          <tr><th class="navbar" align="center"
 34            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
 35          </tr></table></th>
 36  </tr>
 37</table>
 38<table width="100%" cellpadding="0" cellspacing="0">
 39  <tr valign="top">
 40    <td width="100%">
 41      <span class="breadcrumbs">
 42        <a href="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
 43        Module&nbsp;artist
 44      </span>
 45    </td>
 46    <td>
 47      <table cellpadding="0" cellspacing="0">
 48        <!-- hide/show private -->
 49        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 50    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 51        <tr><td align="right"><span class="options"
 52            >[<a href="frames.html" target="_top">frames</a
 53            >]&nbsp;|&nbsp;<a href="pyechonest.artist-module.html"
 54            target="_top">no&nbsp;frames</a>]</span></td></tr>
 55      </table>
 56    </td>
 57  </tr>
 58</table>
 59<!-- ==================== MODULE DESCRIPTION ==================== -->
 60<h1 class="epydoc">Module artist</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.artist-pysrc.html">source&nbsp;code</a></span></p>
 61<p>Copyright (c) 2010 The Echo Nest. All rights reserved.
 62Created by Tyler Williams on 2010-04-25.</p>
 63<p>The Artist module loosely covers <a class="rst-reference external" href="http://developer.echonest.com/docs/v4/artist.html" target="_top">http://developer.echonest.com/docs/v4/artist.html</a>
 64Refer to the official api documentation if you are unsure about something.</p>
 65
 66<!-- ==================== CLASSES ==================== -->
 67<a name="section-Classes"></a>
 68<table class="summary" border="1" cellpadding="3"
 69       cellspacing="0" width="100%" bgcolor="white">
 70<tr bgcolor="#70b0f0" class="table-header">
 71  <td colspan="2" class="table-header">
 72    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 73      <tr valign="top">
 74        <td align="left"><span class="table-header">Classes</span></td>
 75        <td align="right" valign="top"
 76         ><span class="options">[<a href="#section-Classes"
 77         class="privatelink" onclick="toggle_private();"
 78         >hide private</a>]</span></td>
 79      </tr>
 80    </table>
 81  </td>
 82</tr>
 83<tr>
 84    <td width="15%" align="right" valign="top" class="summary">
 85      <span class="summary-type">&nbsp;</span>
 86    </td><td class="summary">
 87        <a href="pyechonest.artist.Artist-class.html" class="summary-name">Artist</a><br />
 88      An Artist object
 89    </td>
 90  </tr>
 91</table>
 92<!-- ==================== FUNCTIONS ==================== -->
 93<a name="section-Functions"></a>
 94<table class="summary" border="1" cellpadding="3"
 95       cellspacing="0" width="100%" bgcolor="white">
 96<tr bgcolor="#70b0f0" class="table-header">
 97  <td colspan="2" class="table-header">
 98    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 99      <tr valign="top">
100        <td align="left"><span class="table-header">Functions</span></td>
101        <td align="right" valign="top"
102         ><span class="options">[<a href="#section-Functions"
103         class="privatelink" onclick="toggle_private();"
104         >hide private</a>]</span></td>
105      </tr>
106    </table>
107  </td>
108</tr>
109<tr>
110    <td width="15%" align="right" valign="top" class="summary">
111      <span class="summary-type">&nbsp;</span>
112    </td><td class="summary">
113      <table width="100%" cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td><span class="summary-sig"><a href="pyechonest.artist-module.html#search" class="summary-sig-name">search</a>(<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
116        <span class="summary-sig-arg">description</span>=<span class="summary-sig-default">None</span>,
117        <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>,
118        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
119        <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>,
120        <span class="summary-sig-arg">fuzzy_match</span>=<span class="summary-sig-default">False</span>,
121        <span class="summary-sig-arg">sort</span>=<span class="summary-sig-default">None</span>,
122        <span class="summary-sig-arg">max_familiarity</span>=<span class="summary-sig-default">None</span>,
123        <span class="summary-sig-arg">min_familiarity</span>=<span class="summary-sig-default">None</span>,
124        <span class="summary-sig-arg">max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
125        <span class="summary-sig-arg">min_hotttnesss</span>=<span class="summary-sig-default">None</span>)</span><br />
126      Search for artists by name, description, or constraint.</td>
127          <td align="right" valign="top">
128            <span class="codelink"><a href="pyechonest.artist-pysrc.html#search">source&nbsp;code</a></span>
129            
130          </td>
131        </tr>
132      </table>
133      
134    </td>
135  </tr>
136<tr>
137    <td width="15%" align="right" valign="top" class="summary">
138      <span class="summary-type">&nbsp;</span>
139    </td><td class="summary">
140      <table width="100%" cellpadding="0" cellspacing="0" border="0">
141        <tr>
142          <td><span class="summary-sig"><a href="pyechonest.artist-module.html#top_hottt" class="summary-sig-name">top_hottt</a>(<span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0</span>,
143        <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>,
144        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
145        <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>)</span><br />
146      Get the top hotttest artists, according to The Echo Nest</td>
147          <td align="right" valign="top">
148            <span class="codelink"><a href="pyechonest.artist-pysrc.html#top_hottt">source&nbsp;code</a></span>
149            
150          </td>
151        </tr>
152      </table>
153      
154    </td>
155  </tr>
156<tr>
157    <td width="15%" align="right" valign="top" class="summary">
158      <span class="summary-type">&nbsp;</span>
159    </td><td class="summary">
160      <table width="100%" cellpadding="0" cellspacing="0" border="0">
161        <tr>
162          <td><span class="summary-sig"><a href="pyechonest.artist-module.html#top_terms" class="summary-sig-name">top_terms</a>(<span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>)</span><br />
163      Get a list of the top overall terms</td>
164          <td align="right" valign="top">
165            <span class="codelink"><a href="pyechonest.artist-pysrc.html#top_terms">source&nbsp;code</a></span>
166            
167          </td>
168        </tr>
169      </table>
170      
171    </td>
172  </tr>
173<tr>
174    <td width="15%" align="right" valign="top" class="summary">
175      <span class="summary-type">&nbsp;</span>
176    </td><td class="summary">
177      <table width="100%" cellpadding="0" cellspacing="0" border="0">
178        <tr>
179          <td><span class="summary-sig"><a href="pyechonest.artist-module.html#similar" class="summary-sig-name">similar</a>(<span class="summary-sig-arg">names</span>=<span class="summary-sig-default">None</span>,
180        <span class="summary-sig-arg">ids</span>=<span class="summary-sig-default">None</span>,
181        <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0</span>,
182        <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>,
183        <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
184        <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>,
185        <span class="summary-sig-arg">max_familiarity</span>=<span class="summary-sig-default">None</span>,
186        <span class="summary-sig-arg">min_familiarity</span>=<span class="summary-sig-default">None</span>,
187        <span class="summary-sig-arg">max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
188        <span class="summary-sig-arg">min_hotttnesss</span>=<span class="summary-sig-default">None</span>)</span><br />
189      Return similar artists to this one</td>
190          <td align="right" valign="top">
191            <span class="codelink"><a href="pyechonest.artist-pysrc.html#similar">source&nbsp;code</a></span>
192            
193          </td>
194        </tr>
195      </table>
196      
197    </td>
198  </tr>
199</table>
200<!-- ==================== VARIABLES ==================== -->
201<a name="section-Variables"></a>
202<table class="summary" border="1" cellpadding="3"
203       cellspacing="0" width="100%" bgcolor="white">
204<tr bgcolor="#70b0f0" class="table-header">
205  <td colspan="2" class="table-header">
206    <table border="0" cellpadding="0" cellspacing="0" width="100%">
207      <tr valign="top">
208        <td align="left"><span class="table-header">Variables</span></td>
209        <td align="right" valign="top"
210         ><span class="options">[<a href="#section-Variables"
211         class="privatelink" onclick="toggle_private();"
212         >hide private</a>]</span></td>
213      </tr>
214    </table>
215  </td>
216</tr>
217<tr>
218    <td width="15%" align="right" valign="top" class="summary">
219      <span class="summary-type">&nbsp;</span>
220    </td><td class="summary">
221        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pyechonest'"><code class="variable-quote">'</code><code class="variable-string">pyechonest</code><code class="variable-quote">'</code></code>
222    </td>
223  </tr>
224</table>
225<!-- ==================== FUNCTION DETAILS ==================== -->
226<a name="section-FunctionDetails"></a>
227<table class="details" border="1" cellpadding="3"
228       cellspacing="0" width="100%" bgcolor="white">
229<tr bgcolor="#70b0f0" class="table-header">
230  <td colspan="2" class="table-header">
231    <table border="0" cellpadding="0" cellspacing="0" width="100%">
232      <tr valign="top">
233        <td align="left"><span class="table-header">Function Details</span></td>
234        <td align="right" valign="top"
235         ><span class="options">[<a href="#section-FunctionDetails"
236         class="privatelink" onclick="toggle_private();"
237         >hide private</a>]</span></td>
238      </tr>
239    </table>
240  </td>
241</tr>
242</table>
243<a name="search"></a>
244<div>
245<table class="details" border="1" cellpadding="3"
246       cellspacing="0" width="100%" bgcolor="white">
247<tr><td>
248  <table width="100%" cellpadding="0" cellspacing="0" border="0">
249  <tr valign="top"><td>
250  <h3 class="epydoc"><span class="sig"><span class="sig-name">search</span>(<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
251        <span class="sig-arg">description</span>=<span class="sig-default">None</span>,
252        <span class="sig-arg">results</span>=<span class="sig-default">15</span>,
253        <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
254        <span class="sig-arg">limit</span>=<span class="sig-default">False</span>,
255        <span class="sig-arg">fuzzy_match</span>=<span class="sig-default">False</span>,
256        <span class="sig-arg">sort</span>=<span class="sig-default">None</span>,
257        <span class="sig-arg">max_familiarity</span>=<span class="sig-default">None</span>,
258        <span class="sig-arg">min_familiarity</span>=<span class="sig-default">None</span>,
259        <span class="sig-arg">max_hotttnesss</span>=<span class="sig-default">None</span>,
260        <span class="sig-arg">min_hotttnesss</span>=<span class="sig-default">None</span>)</span>
261  </h3>
262  </td><td align="right" valign="top"
263    ><span class="codelink"><a href="pyechonest.artist-pysrc.html#search">source&nbsp;code</a></span>&nbsp;
264    </td>
265  </tr></table>
266  
267  <p>Search for artists by name, description, or constraint.</p>
268<dl class="rst-docutils">
269<dt>Args:</dt>
270<dd>name: the name of an artist
271description: A string describing the artist
272results: An integer number of results to return
273buckets: A list of strings specifying which buckets to retrieve
274limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets
275fuzzy_match: A boolean indicating whether or not to search for similar sounding matches (only works with name)
276max_familiarity: A float specifying the max familiarity of artists to search for
277min_familiarity: A float specifying the min familiarity of artists to search for
278max_hotttnesss: A float specifying the max hotttnesss of artists to search for
279min_hotttnesss: A float specifying the max hotttnesss of artists to search for</dd>
280<dt>Returns:</dt>
281<dd>A list of Artist objects</dd>
282</dl>
283  <dl class="fields">
284  </dl>
285</td></tr></table>
286</div>
287<a name="top_hottt"></a>
288<div>
289<table class="details" border="1" cellpadding="3"
290       cellspacing="0" width="100%" bgcolor="white">
291<tr><td>
292  <table width="100%" cellpadding="0" cellspacing="0" border="0">
293  <tr valign="top"><td>
294  <h3 class="epydoc"><span class="sig"><span class="sig-name">top_hottt</span>(<span class="sig-arg">start</span>=<span class="sig-default">0</span>,
295        <span class="sig-arg">results</span>=<span class="sig-default">15</span>,
296        <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
297        <span class="sig-arg">limit</span>=<span class="sig-default">False</span>)</span>
298  </h3>
299  </td><td align="right" valign="top"
300    ><span class="codelink"><a href="pyechonest.artist-pysrc.html#top_hottt">source&nbsp;code</a></span>&nbsp;
301    </td>
302  </tr></table>
303  
304  <p>Get the top hotttest artists, according to The Echo Nest</p>
305<dl class="rst-docutils">
306<dt>Args:</dt>
307<dd>results: An integer number of results to return
308start: An integer starting value for the result set
309buckets: A list of strings specifying which buckets to retrieve
310limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</dd>
311<dt>Returns:</dt>
312<dd>A list of hottt Artist objects</dd>
313</dl>
314  <dl class="fields">
315  </dl>
316</td></tr></table>
317</div>
318<a name="top_terms"></a>
319<div>
320<table class="details" border="1" cellpadding="3"
321       cellspacing="0" width="100%" bgcolor="white">
322<tr><td>
323  <table width="100%" cellpadding="0" cellspacing="0" border="0">
324  <tr valign="top"><td>
325  <h3 class="epydoc"><span class="sig"><span class="sig-name">top_terms</span>(<span class="sig-arg">results</span>=<span class="sig-default">15</span>)</span>
326  </h3>
327  </td><td align="right" valign="top"
328    ><span class="codelink"><a href="pyechonest.artist-pysrc.html#top_terms">source&nbsp;code</a></span>&nbsp;
329    </td>
330  </tr></table>
331  
332  <p>Get a list of the top overall terms</p>
333<dl class="rst-docutils">
334<dt>Args:</dt>
335<dd>results: An integer number of results to return</dd>
336<dt>Returns:</dt>
337<dd>A list of term document Result objects</dd>
338</dl>
339  <dl class="fields">
340  </dl>
341</td></tr></table>
342</div>
343<a name="similar"></a>
344<div>
345<table class="details" border="1" cellpadding="3"
346       cellspacing="0" width="100%" bgcolor="white">
347<tr><td>
348  <table width="100%" cellpadding="0" cellspacing="0" border="0">
349  <tr valign="top"><td>
350  <h3 class="epydoc"><span class="sig"><span class="sig-name">similar</span>(<span class="sig-arg">names</span>=<span class="sig-default">None</span>,
351        <span class="sig-arg">ids</span>=<span class="sig-default">None</span>,
352        <span class="sig-arg">start</span>=<span class="sig-default">0</span>,
353        <span class="sig-arg">results</span>=<span class="sig-default">15</span>,
354        <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
355        <span class="sig-arg">limit</span>=<span class="sig-default">False</span>,
356        <span class="sig-arg">max_familiarity</span>=<span class="sig-default">None</span>,
357        <span class="sig-arg">min_familiarity</span>=<span class="sig-default">None</span>,
358        <span class="sig-arg">max_hotttnesss</span>=<span class="sig-default">None</span>,
359        <span class="sig-arg">min_hotttnesss</span>=<span class="sig-default">None</span>)</span>
360  </h3>
361  </td><td align="right" valign="top"
362    ><span class="codelink"><a href="pyechonest.artist-pysrc.html#similar">source&nbsp;code</a></span>&nbsp;
363    </td>
364  </tr></table>
365  
366  <p>Return similar artists to this one</p>
367<dl class="rst-docutils">
368<dt>Args:</dt>
369<dd>id: An artist id or list of ids
370name: An artist name or list of names
371results: An integer number of results to return
372buckets: A list of strings specifying which buckets to retrieve
373limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets
374start: An integer starting value for the result set
375buckets: A list of strings specifying which buckets to retrieve
376limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets
377max_familiarity: A float specifying the max familiarity of artists to search for
378min_familiarity: A float specifying the min familiarity of artists to search for
379max_hotttnesss: A float specifying the max hotttnesss of artists to search for
380min_hotttnesss: A float specifying the max hotttnesss of artists to search for</dd>
381<dt>Returns:</dt>
382<dd>A list of similar Artist objects</dd>
383</dl>
384  <dl class="fields">
385  </dl>
386</td></tr></table>
387</div>
388<br />
389<!-- ==================== NAVIGATION BAR ==================== -->
390<table class="navbar" border="0" width="100%" cellpadding="0"
391       bgcolor="#a0c0ff" cellspacing="0">
392  <tr valign="middle">
393
394  <!-- Tree link -->
395      <th>&nbsp;&nbsp;&nbsp;<a
396        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
397
398  <!-- Index link -->
399      <th>&nbsp;&nbsp;&nbsp;<a
400        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
401
402  <!-- Help link -->
403      <th>&nbsp;&nbsp;&nbsp;<a
404        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
405
406  <!-- Project homepage -->
407      <th class="navbar" align="right" width="100%">
408        <table border="0" cellpadding="0" cellspacing="0">
409          <tr><th class="navbar" align="center"
410            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
411          </tr></table></th>
412  </tr>
413</table>
414<table border="0" cellpadding="0" cellspacing="0" width="100%%">
415  <tr>
416    <td align="left" class="footer">
417    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
418    </td>
419    <td align="right" class="footer">
420      <a target="mainFrame" href="http://epydoc.sourceforge.net"
421        >http://epydoc.sourceforge.net</a>
422    </td>
423  </tr>
424</table>
425
426<script type="text/javascript">
427  <!--
428  // Private objects are initially displayed (because if
429  // javascript is turned off then we want them to be
430  // visible); but by default, we want to hide them.  So hide
431  // them unless we have a cookie that says to show them.
432  checkCookie();
433  // -->
434</script>
435</body>
436</html>