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