/apidocs/pyechonest.config-pysrc.html
HTML | 180 lines | 149 code | 10 blank | 21 comment | 0 complexity | 86591321bf0f8bd3545148e65d91242d 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> <a 20 href="module-tree.html">Trees</a> </th> 21 22 <!-- Index link --> 23 <th> <a 24 href="identifier-index.html">Indices</a> </th> 25 26 <!-- Help link --> 27 <th> <a 28 href="help.html">Help</a> </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 pyechonest</a> :: 43 Module 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 private</a>]</span></td></tr> 51 <tr><td align="right"><span class="options" 52 >[<a href="frames.html" target="_top">frames</a 53 >] | <a href="pyechonest.config-pysrc.html" 54 target="_top">no frames</a>]</span></td></tr> 55 </table> 56 </td> 57 </tr> 58</table> 59<h1 class="epydoc">Source Code for <a href="pyechonest.config-module.html">Module pyechonest.config</a></h1> 60<pre class="py-src"> 61<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt> 62<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"># encoding: utf-8</tt> </tt> 63<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"> </tt> 64<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt> 65<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring">Copyright (c) 2010 The Echo Nest. All rights reserved.</tt> </tt> 66<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring">Created by Tyler Williams on 2010-04-25.</tt> </tt> 67<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 68<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring">Global configuration variables for accessing the Echo Nest web API.</tt> </tt> 69<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt> 70<a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"> </tt> 71<a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-string">"4.2.5"</tt> </tt> 72<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"> </tt> 73<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt> 74<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> </tt> 75<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-keyword">if</tt><tt class="py-op">(</tt><tt class="py-string">'ECHO_NEST_API_KEY'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 76<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> <tt id="link-0" class="py-name" targets="Variable pyechonest.config.ECHO_NEST_API_KEY=pyechonest.config-module.html#ECHO_NEST_API_KEY"><a title="pyechonest.config.ECHO_NEST_API_KEY" class="py-name" href="#" onclick="return doclink('link-0', 'ECHO_NEST_API_KEY', 'link-0');">ECHO_NEST_API_KEY</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">[</tt><tt class="py-string">'ECHO_NEST_API_KEY'</tt><tt class="py-op">]</tt> </tt> 77<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 78<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"> <tt id="link-1" class="py-name"><a title="pyechonest.config.ECHO_NEST_API_KEY" class="py-name" href="#" onclick="return doclink('link-1', 'ECHO_NEST_API_KEY', 'link-0');">ECHO_NEST_API_KEY</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> 79<a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"> </tt> 80<a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> </tt> 81<a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"><tt id="link-2" class="py-name" targets="Variable pyechonest.config.API_HOST=pyechonest.config-module.html#API_HOST"><a title="pyechonest.config.API_HOST" class="py-name" href="#" onclick="return doclink('link-2', 'API_HOST', 'link-2');">API_HOST</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'developer.echonest.com'</tt> </tt> 82<a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"> </tt> 83<a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"><tt id="link-3" class="py-name" targets="Variable pyechonest.config.API_SELECTOR=pyechonest.config-module.html#API_SELECTOR"><a title="pyechonest.config.API_SELECTOR" class="py-name" href="#" onclick="return doclink('link-3', 'API_SELECTOR', 'link-3');">API_SELECTOR</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'api'</tt> </tt> 84<a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-string">"Locations for the Analyze API calls."</tt> </tt> 85<a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"> </tt> 86<a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"><tt id="link-4" class="py-name" targets="Variable pyechonest.config.API_VERSION=pyechonest.config-module.html#API_VERSION"><a title="pyechonest.config.API_VERSION" class="py-name" href="#" onclick="return doclink('link-4', 'API_VERSION', 'link-4');">API_VERSION</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'v4'</tt> </tt> 87<a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"><tt class="py-string">"Version of api to use... only 4 for now"</tt> </tt> 88<a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"> </tt> 89<a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"><tt id="link-5" class="py-name" targets="Variable pyechonest.config.HTTP_USER_AGENT=pyechonest.config-module.html#HTTP_USER_AGENT"><a title="pyechonest.config.HTTP_USER_AGENT" class="py-name" href="#" onclick="return doclink('link-5', 'HTTP_USER_AGENT', 'link-5');">HTTP_USER_AGENT</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'PyEchonest'</tt> </tt> 90<a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 91<a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-string">You may change this to be a user agent string of your</tt> </tt> 92<a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"><tt class="py-string">own choosing.</tt> </tt> 93<a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 94<a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"> </tt> 95<a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"><tt id="link-6" class="py-name" targets="Variable pyechonest.config.MP3_BITRATE=pyechonest.config-module.html#MP3_BITRATE"><a title="pyechonest.config.MP3_BITRATE" class="py-name" href="#" onclick="return doclink('link-6', 'MP3_BITRATE', 'link-6');">MP3_BITRATE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">128</tt> </tt> 96<a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 97<a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"><tt class="py-string">Default bitrate for MP3 output. Conventionally an</tt> </tt> 98<a name="L38"></a><tt class="py-lineno">38</tt> <tt class="py-line"><tt class="py-string">integer divisible by 32kbits/sec.</tt> </tt> 99<a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 100<a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"> </tt> 101<a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"><tt id="link-7" class="py-name" targets="Variable pyechonest.config.CACHE=pyechonest.config-module.html#CACHE"><a title="pyechonest.config.CACHE" class="py-name" href="#" onclick="return doclink('link-7', 'CACHE', 'link-7');">CACHE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> 102<a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 103<a name="L43"></a><tt class="py-lineno">43</tt> <tt class="py-line"><tt class="py-string">You may change this to False to prevent local caching</tt> </tt> 104<a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"><tt class="py-string">of API results.</tt> </tt> 105<a name="L45"></a><tt class="py-lineno">45</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 106<a name="L46"></a><tt class="py-lineno">46</tt> <tt class="py-line"> </tt> 107<a name="L47"></a><tt class="py-lineno">47</tt> <tt class="py-line"><tt id="link-8" class="py-name" targets="Variable pyechonest.config.TRACE_API_CALLS=pyechonest.config-module.html#TRACE_API_CALLS"><a title="pyechonest.config.TRACE_API_CALLS" class="py-name" href="#" onclick="return doclink('link-8', 'TRACE_API_CALLS', 'link-8');">TRACE_API_CALLS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> 108<a name="L48"></a><tt class="py-lineno">48</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 109<a name="L49"></a><tt class="py-lineno">49</tt> <tt class="py-line"><tt class="py-string">If true, API calls will be traced to the console</tt> </tt> 110<a name="L50"></a><tt class="py-lineno">50</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 111<a name="L51"></a><tt class="py-lineno">51</tt> <tt class="py-line"> </tt> 112<a name="L52"></a><tt class="py-lineno">52</tt> <tt class="py-line"><tt id="link-9" class="py-name" targets="Variable pyechonest.config.ANALYSIS_VERSION=pyechonest.config-module.html#ANALYSIS_VERSION"><a title="pyechonest.config.ANALYSIS_VERSION" class="py-name" href="#" onclick="return doclink('link-9', 'ANALYSIS_VERSION', 'link-9');">ANALYSIS_VERSION</a></tt> <tt class="py-op">=</tt> <tt class="py-number">3</tt> </tt> 113<a name="L53"></a><tt class="py-lineno">53</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 114<a name="L54"></a><tt class="py-lineno">54</tt> <tt class="py-line"><tt class="py-string">Analysis version</tt> </tt> 115<a name="L55"></a><tt class="py-lineno">55</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 116<a name="L56"></a><tt class="py-lineno">56</tt> <tt class="py-line"> </tt> 117<a name="L57"></a><tt class="py-lineno">57</tt> <tt class="py-line"><tt id="link-10" class="py-name" targets="Variable pyechonest.config.CALL_TIMEOUT=pyechonest.config-module.html#CALL_TIMEOUT"><a title="pyechonest.config.CALL_TIMEOUT" class="py-name" href="#" onclick="return doclink('link-10', 'CALL_TIMEOUT', 'link-10');">CALL_TIMEOUT</a></tt> <tt class="py-op">=</tt> <tt class="py-number">10</tt> </tt> 118<a name="L58"></a><tt class="py-lineno">58</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 119<a name="L59"></a><tt class="py-lineno">59</tt> <tt class="py-line"><tt class="py-string">The API call timeout in seconds. </tt> </tt> 120<a name="L60"></a><tt class="py-lineno">60</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 121<a name="L61"></a><tt class="py-lineno">61</tt> <tt class="py-line"> </tt> 122<a name="L62"></a><tt class="py-lineno">62</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable pyechonest.config.CODEGEN_BINARY_OVERRIDE=pyechonest.config-module.html#CODEGEN_BINARY_OVERRIDE"><a title="pyechonest.config.CODEGEN_BINARY_OVERRIDE" class="py-name" href="#" onclick="return doclink('link-11', 'CODEGEN_BINARY_OVERRIDE', 'link-11');">CODEGEN_BINARY_OVERRIDE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> 123<a name="L63"></a><tt class="py-lineno">63</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 124<a name="L64"></a><tt class="py-lineno">64</tt> <tt class="py-line"><tt class="py-string">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</tt> </tt> 125<a name="L65"></a><tt class="py-lineno">65</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt> 126<a name="L66"></a><tt class="py-lineno">66</tt> <tt class="py-line"> </tt><script type="text/javascript"> 127<!-- 128expandto(location.href); 129// --> 130</script> 131</pre> 132<br /> 133<!-- ==================== NAVIGATION BAR ==================== --> 134<table class="navbar" border="0" width="100%" cellpadding="0" 135 bgcolor="#a0c0ff" cellspacing="0"> 136 <tr valign="middle"> 137 138 <!-- Tree link --> 139 <th> <a 140 href="module-tree.html">Trees</a> </th> 141 142 <!-- Index link --> 143 <th> <a 144 href="identifier-index.html">Indices</a> </th> 145 146 <!-- Help link --> 147 <th> <a 148 href="help.html">Help</a> </th> 149 150 <!-- Project homepage --> 151 <th class="navbar" align="right" width="100%"> 152 <table border="0" cellpadding="0" cellspacing="0"> 153 <tr><th class="navbar" align="center" 154 ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th> 155 </tr></table></th> 156 </tr> 157</table> 158<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 159 <tr> 160 <td align="left" class="footer"> 161 Generated by Epydoc 3.0.1 on Wed Sep 1 16:09:01 2010 162 </td> 163 <td align="right" class="footer"> 164 <a target="mainFrame" href="http://epydoc.sourceforge.net" 165 >http://epydoc.sourceforge.net</a> 166 </td> 167 </tr> 168</table> 169 170<script type="text/javascript"> 171 <!-- 172 // Private objects are initially displayed (because if 173 // javascript is turned off then we want them to be 174 // visible); but by default, we want to hide them. So hide 175 // them unless we have a cookie that says to show them. 176 checkCookie(); 177 // --> 178</script> 179</body> 180</html>