/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
- <?xml version="1.0" encoding="ascii"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <title>pyechonest.artist</title>
- <link rel="stylesheet" href="epydoc.css" type="text/css" />
- <script type="text/javascript" src="epydoc.js"></script>
- </head>
- <body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <span class="breadcrumbs">
- <a href="pyechonest-module.html">Package pyechonest</a> ::
- Module artist
- </span>
- </td>
- <td>
- <table cellpadding="0" cellspacing="0">
- <!-- hide/show private -->
- <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
- onclick="toggle_private();">hide private</a>]</span></td></tr>
- <tr><td align="right"><span class="options"
- >[<a href="frames.html" target="_top">frames</a
- >] | <a href="pyechonest.artist-module.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== MODULE DESCRIPTION ==================== -->
- <h1 class="epydoc">Module artist</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.artist-pysrc.html">source code</a></span></p>
- <p>Copyright (c) 2010 The Echo Nest. All rights reserved.
- Created by Tyler Williams on 2010-04-25.</p>
- <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>
- Refer to the official api documentation if you are unsure about something.</p>
- <!-- ==================== CLASSES ==================== -->
- <a name="section-Classes"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Classes</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Classes"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="pyechonest.artist.Artist-class.html" class="summary-name">Artist</a><br />
- An Artist object
- </td>
- </tr>
- </table>
- <!-- ==================== FUNCTIONS ==================== -->
- <a name="section-Functions"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Functions</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Functions"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">description</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>,
- <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>,
- <span class="summary-sig-arg">fuzzy_match</span>=<span class="summary-sig-default">False</span>,
- <span class="summary-sig-arg">sort</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">max_familiarity</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">min_familiarity</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">min_hotttnesss</span>=<span class="summary-sig-default">None</span>)</span><br />
- Search for artists by name, description, or constraint.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.artist-pysrc.html#search">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>,
- <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>)</span><br />
- Get the top hotttest artists, according to The Echo Nest</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.artist-pysrc.html#top_hottt">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- Get a list of the top overall terms</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.artist-pysrc.html#top_terms">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">ids</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0</span>,
- <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">15</span>,
- <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>,
- <span class="summary-sig-arg">max_familiarity</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">min_familiarity</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">min_hotttnesss</span>=<span class="summary-sig-default">None</span>)</span><br />
- Return similar artists to this one</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.artist-pysrc.html#similar">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- </table>
- <!-- ==================== VARIABLES ==================== -->
- <a name="section-Variables"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Variables</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Variables"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <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>
- </td>
- </tr>
- </table>
- <!-- ==================== FUNCTION DETAILS ==================== -->
- <a name="section-FunctionDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Function Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-FunctionDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="search"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">search</span>(<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">description</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">results</span>=<span class="sig-default">15</span>,
- <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">limit</span>=<span class="sig-default">False</span>,
- <span class="sig-arg">fuzzy_match</span>=<span class="sig-default">False</span>,
- <span class="sig-arg">sort</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">max_familiarity</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">min_familiarity</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">max_hotttnesss</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">min_hotttnesss</span>=<span class="sig-default">None</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="pyechonest.artist-pysrc.html#search">source code</a></span>
- </td>
- </tr></table>
-
- <p>Search for artists by name, description, or constraint.</p>
- <dl class="rst-docutils">
- <dt>Args:</dt>
- <dd>name: the name of an artist
- description: A string describing the artist
- results: An integer number of results to return
- buckets: A list of strings specifying which buckets to retrieve
- limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets
- fuzzy_match: A boolean indicating whether or not to search for similar sounding matches (only works with name)
- max_familiarity: A float specifying the max familiarity of artists to search for
- min_familiarity: A float specifying the min familiarity of artists to search for
- max_hotttnesss: A float specifying the max hotttnesss of artists to search for
- min_hotttnesss: A float specifying the max hotttnesss of artists to search for</dd>
- <dt>Returns:</dt>
- <dd>A list of Artist objects</dd>
- </dl>
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="top_hottt"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <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>,
- <span class="sig-arg">results</span>=<span class="sig-default">15</span>,
- <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">limit</span>=<span class="sig-default">False</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="pyechonest.artist-pysrc.html#top_hottt">source code</a></span>
- </td>
- </tr></table>
-
- <p>Get the top hotttest artists, according to The Echo Nest</p>
- <dl class="rst-docutils">
- <dt>Args:</dt>
- <dd>results: An integer number of results to return
- start: An integer starting value for the result set
- buckets: A list of strings specifying which buckets to retrieve
- limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets</dd>
- <dt>Returns:</dt>
- <dd>A list of hottt Artist objects</dd>
- </dl>
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="top_terms"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <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>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="pyechonest.artist-pysrc.html#top_terms">source code</a></span>
- </td>
- </tr></table>
-
- <p>Get a list of the top overall terms</p>
- <dl class="rst-docutils">
- <dt>Args:</dt>
- <dd>results: An integer number of results to return</dd>
- <dt>Returns:</dt>
- <dd>A list of term document Result objects</dd>
- </dl>
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="similar"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">similar</span>(<span class="sig-arg">names</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">ids</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">start</span>=<span class="sig-default">0</span>,
- <span class="sig-arg">results</span>=<span class="sig-default">15</span>,
- <span class="sig-arg">buckets</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">limit</span>=<span class="sig-default">False</span>,
- <span class="sig-arg">max_familiarity</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">min_familiarity</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">max_hotttnesss</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">min_hotttnesss</span>=<span class="sig-default">None</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="pyechonest.artist-pysrc.html#similar">source code</a></span>
- </td>
- </tr></table>
-
- <p>Return similar artists to this one</p>
- <dl class="rst-docutils">
- <dt>Args:</dt>
- <dd>id: An artist id or list of ids
- name: An artist name or list of names
- results: An integer number of results to return
- buckets: A list of strings specifying which buckets to retrieve
- limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets
- start: An integer starting value for the result set
- buckets: A list of strings specifying which buckets to retrieve
- limit: A boolean indicating whether or not to limit the results to one of the id spaces specified in buckets
- max_familiarity: A float specifying the max familiarity of artists to search for
- min_familiarity: A float specifying the min familiarity of artists to search for
- max_hotttnesss: A float specifying the max hotttnesss of artists to search for
- min_hotttnesss: A float specifying the max hotttnesss of artists to search for</dd>
- <dt>Returns:</dt>
- <dd>A list of similar Artist objects</dd>
- </dl>
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table border="0" cellpadding="0" cellspacing="0" width="100%%">
- <tr>
- <td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:57 2010
- </td>
- <td align="right" class="footer">
- <a target="mainFrame" href="http://epydoc.sourceforge.net"
- >http://epydoc.sourceforge.net</a>
- </td>
- </tr>
- </table>
- <script type="text/javascript">
- <!--
- // Private objects are initially displayed (because if
- // javascript is turned off then we want them to be
- // visible); but by default, we want to hide them. So hide
- // them unless we have a cookie that says to show them.
- checkCookie();
- // -->
- </script>
- </body>
- </html>