PageRenderTime 266ms CodeModel.GetById 151ms app.highlight 17ms RepoModel.GetById 93ms app.codeStats 0ms

/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
  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.config</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;config
 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.config-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 config</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.config-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>Global configuration variables for accessing the Echo Nest web API.</p>
 64
 65<hr />
 66<div class="fields">      <p><strong>Version:</strong>
 67        4.2.5
 68      </p>
 69</div><!-- ==================== VARIABLES ==================== -->
 70<a name="section-Variables"></a>
 71<table class="summary" border="1" cellpadding="3"
 72       cellspacing="0" width="100%" bgcolor="white">
 73<tr bgcolor="#70b0f0" class="table-header">
 74  <td colspan="2" class="table-header">
 75    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 76      <tr valign="top">
 77        <td align="left"><span class="table-header">Variables</span></td>
 78        <td align="right" valign="top"
 79         ><span class="options">[<a href="#section-Variables"
 80         class="privatelink" onclick="toggle_private();"
 81         >hide private</a>]</span></td>
 82      </tr>
 83    </table>
 84  </td>
 85</tr>
 86<tr>
 87    <td width="15%" align="right" valign="top" class="summary">
 88      <span class="summary-type">&nbsp;</span>
 89    </td><td class="summary">
 90        <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>
 91    </td>
 92  </tr>
 93<tr>
 94    <td width="15%" align="right" valign="top" class="summary">
 95      <span class="summary-type">&nbsp;</span>
 96    </td><td class="summary">
 97        <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>
 98    </td>
 99  </tr>
100<tr>
101    <td width="15%" align="right" valign="top" class="summary">
102      <span class="summary-type">&nbsp;</span>
103    </td><td class="summary">
104        <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 />
105      Locations for the Analyze API calls.
106    </td>
107  </tr>
108<tr>
109    <td width="15%" align="right" valign="top" class="summary">
110      <span class="summary-type">&nbsp;</span>
111    </td><td class="summary">
112        <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 />
113      Version of api to use...
114    </td>
115  </tr>
116<tr>
117    <td width="15%" align="right" valign="top" class="summary">
118      <span class="summary-type">&nbsp;</span>
119    </td><td class="summary">
120        <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 />
121      You may change this to be a user agent string of your
122own choosing.
123    </td>
124  </tr>
125<tr>
126    <td width="15%" align="right" valign="top" class="summary">
127      <span class="summary-type">&nbsp;</span>
128    </td><td class="summary">
129        <a href="pyechonest.config-module.html#MP3_BITRATE" class="summary-name">MP3_BITRATE</a> = <code title="128">128</code><br />
130      Default bitrate for MP3 output.
131    </td>
132  </tr>
133<tr>
134    <td width="15%" align="right" valign="top" class="summary">
135      <span class="summary-type">&nbsp;</span>
136    </td><td class="summary">
137        <a name="CACHE"></a><span class="summary-name">CACHE</span> = <code title="True">True</code><br />
138      You may change this to False to prevent local caching
139of API results.
140    </td>
141  </tr>
142<tr>
143    <td width="15%" align="right" valign="top" class="summary">
144      <span class="summary-type">&nbsp;</span>
145    </td><td class="summary">
146        <a name="TRACE_API_CALLS"></a><span class="summary-name">TRACE_API_CALLS</span> = <code title="False">False</code><br />
147      If true, API calls will be traced to the console
148    </td>
149  </tr>
150<tr>
151    <td width="15%" align="right" valign="top" class="summary">
152      <span class="summary-type">&nbsp;</span>
153    </td><td class="summary">
154        <a name="ANALYSIS_VERSION"></a><span class="summary-name">ANALYSIS_VERSION</span> = <code title="3">3</code><br />
155      Analysis version
156    </td>
157  </tr>
158<tr>
159    <td width="15%" align="right" valign="top" class="summary">
160      <span class="summary-type">&nbsp;</span>
161    </td><td class="summary">
162        <a name="CALL_TIMEOUT"></a><span class="summary-name">CALL_TIMEOUT</span> = <code title="10">10</code><br />
163      The API call timeout in seconds.
164    </td>
165  </tr>
166<tr>
167    <td width="15%" align="right" valign="top" class="summary">
168      <span class="summary-type">&nbsp;</span>
169    </td><td class="summary">
170        <a href="pyechonest.config-module.html#CODEGEN_BINARY_OVERRIDE" class="summary-name">CODEGEN_BINARY_OVERRIDE</a> = <code title="None">None</code><br />
171      Location of your codegen binary.
172    </td>
173  </tr>
174<tr>
175    <td width="15%" align="right" valign="top" class="summary">
176      <span class="summary-type">&nbsp;</span>
177    </td><td class="summary">
178        <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>
179    </td>
180  </tr>
181</table>
182<!-- ==================== VARIABLES DETAILS ==================== -->
183<a name="section-VariablesDetails"></a>
184<table class="details" border="1" cellpadding="3"
185       cellspacing="0" width="100%" bgcolor="white">
186<tr bgcolor="#70b0f0" class="table-header">
187  <td colspan="2" class="table-header">
188    <table border="0" cellpadding="0" cellspacing="0" width="100%">
189      <tr valign="top">
190        <td align="left"><span class="table-header">Variables Details</span></td>
191        <td align="right" valign="top"
192         ><span class="options">[<a href="#section-VariablesDetails"
193         class="privatelink" onclick="toggle_private();"
194         >hide private</a>]</span></td>
195      </tr>
196    </table>
197  </td>
198</tr>
199</table>
200<a name="API_VERSION"></a>
201<div>
202<table class="details" border="1" cellpadding="3"
203       cellspacing="0" width="100%" bgcolor="white">
204<tr><td>
205  <h3 class="epydoc">API_VERSION</h3>
206  Version of api to use... only 4 for now
207  <dl class="fields">
208  </dl>
209  <dl class="fields">
210    <dt>Value:</dt>
211      <dd><table><tr><td><pre class="variable">
212<code class="variable-quote">'</code><code class="variable-string">v4</code><code class="variable-quote">'</code>
213</pre></td></tr></table>
214</dd>
215  </dl>
216</td></tr></table>
217</div>
218<a name="MP3_BITRATE"></a>
219<div>
220<table class="details" border="1" cellpadding="3"
221       cellspacing="0" width="100%" bgcolor="white">
222<tr><td>
223  <h3 class="epydoc">MP3_BITRATE</h3>
224  Default bitrate for MP3 output. Conventionally an
225integer divisible by 32kbits/sec.
226  <dl class="fields">
227  </dl>
228  <dl class="fields">
229    <dt>Value:</dt>
230      <dd><table><tr><td><pre class="variable">
231128
232</pre></td></tr></table>
233</dd>
234  </dl>
235</td></tr></table>
236</div>
237<a name="CODEGEN_BINARY_OVERRIDE"></a>
238<div>
239<table class="details" border="1" cellpadding="3"
240       cellspacing="0" width="100%" bgcolor="white">
241<tr><td>
242  <h3 class="epydoc">CODEGEN_BINARY_OVERRIDE</h3>
243  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
244  <dl class="fields">
245  </dl>
246  <dl class="fields">
247    <dt>Value:</dt>
248      <dd><table><tr><td><pre class="variable">
249None
250</pre></td></tr></table>
251</dd>
252  </dl>
253</td></tr></table>
254</div>
255<br />
256<!-- ==================== NAVIGATION BAR ==================== -->
257<table class="navbar" border="0" width="100%" cellpadding="0"
258       bgcolor="#a0c0ff" cellspacing="0">
259  <tr valign="middle">
260
261  <!-- Tree link -->
262      <th>&nbsp;&nbsp;&nbsp;<a
263        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
264
265  <!-- Index link -->
266      <th>&nbsp;&nbsp;&nbsp;<a
267        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
268
269  <!-- Help link -->
270      <th>&nbsp;&nbsp;&nbsp;<a
271        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
272
273  <!-- Project homepage -->
274      <th class="navbar" align="right" width="100%">
275        <table border="0" cellpadding="0" cellspacing="0">
276          <tr><th class="navbar" align="center"
277            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
278          </tr></table></th>
279  </tr>
280</table>
281<table border="0" cellpadding="0" cellspacing="0" width="100%%">
282  <tr>
283    <td align="left" class="footer">
284    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
285    </td>
286    <td align="right" class="footer">
287      <a target="mainFrame" href="http://epydoc.sourceforge.net"
288        >http://epydoc.sourceforge.net</a>
289    </td>
290  </tr>
291</table>
292
293<script type="text/javascript">
294  <!--
295  // Private objects are initially displayed (because if
296  // javascript is turned off then we want them to be
297  // visible); but by default, we want to hide them.  So hide
298  // them unless we have a cookie that says to show them.
299  checkCookie();
300  // -->
301</script>
302</body>
303</html>