/apidocs/pyechonest.config-module.html
http://echo-nest-remix.googlecode.com/ · HTML · 303 lines · 272 code · 11 blank · 20 comment · 0 complexity · 0205a520039eeacc91b1708a0392bc28 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.config</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 config
- </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.config-module.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== MODULE DESCRIPTION ==================== -->
- <h1 class="epydoc">Module config</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.config-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>Global configuration variables for accessing the Echo Nest web API.</p>
- <hr />
- <div class="fields"> <p><strong>Version:</strong>
- 4.2.5
- </p>
- </div><!-- ==================== 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="ECHO_NEST_API_KEY"></a><span class="summary-name">ECHO_NEST_API_KEY</span> = <code title="'5EYHYOVNFLJTJ1KOH'"><code class="variable-quote">'</code><code class="variable-string">5EYHYOVNFLJTJ1KOH</code><code class="variable-quote">'</code></code>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="API_HOST"></a><span class="summary-name">API_HOST</span> = <code title="'developer.echonest.com'"><code class="variable-quote">'</code><code class="variable-string">developer.echonest.com</code><code class="variable-quote">'</code></code>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="API_SELECTOR"></a><span class="summary-name">API_SELECTOR</span> = <code title="'api'"><code class="variable-quote">'</code><code class="variable-string">api</code><code class="variable-quote">'</code></code><br />
- Locations for the Analyze API calls.
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="pyechonest.config-module.html#API_VERSION" class="summary-name">API_VERSION</a> = <code title="'v4'"><code class="variable-quote">'</code><code class="variable-string">v4</code><code class="variable-quote">'</code></code><br />
- Version of api to use...
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="HTTP_USER_AGENT"></a><span class="summary-name">HTTP_USER_AGENT</span> = <code title="'PyEchonest'"><code class="variable-quote">'</code><code class="variable-string">PyEchonest</code><code class="variable-quote">'</code></code><br />
- You may change this to be a user agent string of your
- own choosing.
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="pyechonest.config-module.html#MP3_BITRATE" class="summary-name">MP3_BITRATE</a> = <code title="128">128</code><br />
- Default bitrate for MP3 output.
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="CACHE"></a><span class="summary-name">CACHE</span> = <code title="True">True</code><br />
- You may change this to False to prevent local caching
- of API results.
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="TRACE_API_CALLS"></a><span class="summary-name">TRACE_API_CALLS</span> = <code title="False">False</code><br />
- If true, API calls will be traced to the console
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="ANALYSIS_VERSION"></a><span class="summary-name">ANALYSIS_VERSION</span> = <code title="3">3</code><br />
- Analysis version
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="CALL_TIMEOUT"></a><span class="summary-name">CALL_TIMEOUT</span> = <code title="10">10</code><br />
- The API call timeout in seconds.
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="pyechonest.config-module.html#CODEGEN_BINARY_OVERRIDE" class="summary-name">CODEGEN_BINARY_OVERRIDE</a> = <code title="None">None</code><br />
- Location of your codegen binary.
- </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>
- <!-- ==================== VARIABLES DETAILS ==================== -->
- <a name="section-VariablesDetails"></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">Variables Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-VariablesDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="API_VERSION"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">API_VERSION</h3>
- Version of api to use... only 4 for now
- <dl class="fields">
- </dl>
- <dl class="fields">
- <dt>Value:</dt>
- <dd><table><tr><td><pre class="variable">
- <code class="variable-quote">'</code><code class="variable-string">v4</code><code class="variable-quote">'</code>
- </pre></td></tr></table>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="MP3_BITRATE"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">MP3_BITRATE</h3>
- Default bitrate for MP3 output. Conventionally an
- integer divisible by 32kbits/sec.
- <dl class="fields">
- </dl>
- <dl class="fields">
- <dt>Value:</dt>
- <dd><table><tr><td><pre class="variable">
- 128
- </pre></td></tr></table>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="CODEGEN_BINARY_OVERRIDE"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">CODEGEN_BINARY_OVERRIDE</h3>
- Location of your codegen binary. If not given, we will guess codegen.platform-architecture on your system path, e.g. codegen.Darwin, codegen.Linux-i386
- <dl class="fields">
- </dl>
- <dl class="fields">
- <dt>Value:</dt>
- <dd><table><tr><td><pre class="variable">
- None
- </pre></td></tr></table>
- </dd>
- </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>