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