rebuild
[rainbowstream.git] / docs / _build / html / index.html
index 7c195c7..6bc9bc1 100644 (file)
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Rainbow Stream &mdash; Rainbow Stream 0.1.0 documentation</title>
+    <title>Rainbow Stream &mdash; RainbowStream 0.4.3 documentation</title>
     
     
-    <link rel="stylesheet" href="_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.1.0',
+        VERSION:     '0.4.3',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Rainbow Stream 0.1.0 documentation" href="#" /> 
+    <link rel="top" title="RainbowStream 0.4.3 documentation" href="#" />
+   
+  
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
   </head>
   <body>
   </head>
   <body>
+  
+  
+  <div class=indexwrapper>
+  
+
     <div class="related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
     <div class="related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li><a href="#">Rainbow Stream 0.1.0 documentation</a> &raquo;</li> 
+        <li><a href="#">RainbowStream 0.4.3 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
       </ul>
     </div>  
 
 <a class="reference external image-reference" href="https://pypi.python.org/pypi/rainbowstream"><img alt="http://img.shields.io/pypi/v/rainbowstream.svg?style=flat" src="http://img.shields.io/pypi/v/rainbowstream.svg?style=flat" /></a>
 <p>Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.</p>
 <a class="reference external image-reference" href="https://pypi.python.org/pypi/rainbowstream"><img alt="http://img.shields.io/pypi/v/rainbowstream.svg?style=flat" src="http://img.shields.io/pypi/v/rainbowstream.svg?style=flat" /></a>
 <p>Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.</p>
-<p>This package is built on the top of <a class="reference external" href="http://mike.verdone.ca/twitter/">Python Twitter Tool</a> and <a class="reference external" href="https://dev.twitter.com/docs/api/1.1">Twitter API</a>.</p>
-</div>
-<div class="section" id="showcase">
-<h1>Showcase<a class="headerlink" href="#showcase" title="Permalink to this headline">¶</a></h1>
-<p>Screencast: <a class="reference external" href="https://www.youtube.com/watch?v=tykCvPMJq8s">https://www.youtube.com/watch?v=tykCvPMJq8s</a></p>
-<p>Screenshot:</p>
-<div class="figure">
-<img alt="rainbowstream" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png" />
-</div>
-<div class="figure">
-<img alt="rainbowstreamIOT" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png" />
-</div>
+<p>This package is built on the top of <a class="reference external" href="http://mike.verdone.ca/twitter/">Python Twitter Tool</a> and <a class="reference external" href="https://dev.twitter.com/docs/api/1.1">Twitter API</a>,
+can run on Python 2.7.x and 3.x .</p>
 </div>
 <div class="section" id="install">
 <h1>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h1>
 </div>
 <div class="section" id="install">
 <h1>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h1>
-<p>You will need Python 2.7+ and pip.</p>
+<div class="section" id="the-quick-way">
+<h2>The quick way<a class="headerlink" href="#the-quick-way" title="Permalink to this headline">¶</a></h2>
+<p>You will need Python and pip (2.7.x or 3.x).</p>
 <div class="code bash highlight-python"><div class="highlight"><pre>sudo pip install rainbowstream
 <div class="code bash highlight-python"><div class="highlight"><pre>sudo pip install rainbowstream
+# Python 3 users: sudo pip3 install rainbowstream
 </pre></div>
 </div>
 </pre></div>
 </div>
-<p>or try with a virtualenv</p>
-<div class="code bash highlight-python"><div class="highlight"><pre>sudo pip install virtualenv # skip if you already have virtualenv
-virtualenv venv
-source venv/bin/activate # use the brand new virtualenv.
+</div>
+<div class="section" id="the-recommended-way">
+<h2>The recommended way<a class="headerlink" href="#the-recommended-way" title="Permalink to this headline">¶</a></h2>
+<p>Use <a class="reference external" href="http://docs.python-guide.org/en/latest/dev/virtualenvs/">virtualenv</a></p>
+<div class="code bash highlight-python"><div class="highlight"><pre>virtualenv venv
+# Python 3 users : use -p to specify your Python 3 localtion as below
+# virtualenv -p /usr/bin/python3 venv
+source venv/bin/activate
 pip install rainbowstream
 </pre></div>
 </div>
 </div>
 pip install rainbowstream
 </pre></div>
 </div>
 </div>
+</div>
 <div class="section" id="usage">
 <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="the-stream">
 <h2>The stream<a class="headerlink" href="#the-stream" title="Permalink to this headline">¶</a></h2>
 <p>Just type</p>
 <div class="section" id="usage">
 <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="the-stream">
 <h2>The stream<a class="headerlink" href="#the-stream" title="Permalink to this headline">¶</a></h2>
 <p>Just type</p>
-<div class="code bash highlight-python"><div class="highlight"><pre><span class="n">rainbow</span>
+<div class="code bash highlight-python"><div class="highlight"><pre><span class="n">rainbowstream</span>
 </pre></div>
 </div>
 <p>and see your stream.</p>
 <p>I shipped a feature which can display <strong>tweet&#8217;s images directly on terminal</strong>.
 You can try it with:</p>
 </pre></div>
 </div>
 <p>and see your stream.</p>
 <p>I shipped a feature which can display <strong>tweet&#8217;s images directly on terminal</strong>.
 You can try it with:</p>
-<div class="code bash highlight-python"><div class="highlight"><pre><span class="n">rainbow</span> <span class="o">-</span><span class="n">iot</span> <span class="c"># Or rainbow --image-on-term</span>
+<div class="code bash highlight-python"><div class="highlight"><pre><span class="n">rainbowstream</span> <span class="o">-</span><span class="n">iot</span> <span class="c"># Or rainbowstream --image-on-term</span>
 </pre></div>
 </div>
 <p>In the first time you will be asked for authorization of Rainbow Stream
 </pre></div>
 </div>
 <p>In the first time you will be asked for authorization of Rainbow Stream
@@ -113,8 +120,8 @@ mention tweets.</li>
 <li><tt class="docutils literal"><span class="pre">whois</span> <span class="pre">&#64;dtvd88</span></tt> will show profile of &#64;dtvd88.</li>
 <li><tt class="docutils literal"><span class="pre">view</span> <span class="pre">&#64;mdo</span></tt> will show &#64;mdo ’s timeline. <tt class="docutils literal"><span class="pre">view</span> <span class="pre">&#64;dmo</span> <span class="pre">9</span></tt> will print
 exactly 9 tweets.</li>
 <li><tt class="docutils literal"><span class="pre">whois</span> <span class="pre">&#64;dtvd88</span></tt> will show profile of &#64;dtvd88.</li>
 <li><tt class="docutils literal"><span class="pre">view</span> <span class="pre">&#64;mdo</span></tt> will show &#64;mdo ’s timeline. <tt class="docutils literal"><span class="pre">view</span> <span class="pre">&#64;dmo</span> <span class="pre">9</span></tt> will print
 exactly 9 tweets.</li>
-<li><tt class="docutils literal"><span class="pre">s</span> <span class="pre">#noah</span></tt> will search the word <em>‘noah’</em>. Result will come back with
-highlight.</li>
+<li><tt class="docutils literal"><span class="pre">s</span> <span class="pre">noah</span></tt> will search the word <em>‘noah’</em>. Result will come back with
+highlight. Search can be performed with or without hashtag.</li>
 </ul>
 <p><strong>Tweet Commands</strong></p>
 <ul class="simple">
 </ul>
 <p><strong>Tweet Commands</strong></p>
 <ul class="simple">
@@ -122,6 +129,8 @@ highlight.</li>
 rainbow is god’s promise to noah’</em>.</li>
 <li><tt class="docutils literal"><span class="pre">rt</span> <span class="pre">12</span></tt> will retweet the tweet with <em>[id=12]</em>. You can see id of
 each tweet beside the time.</li>
 rainbow is god’s promise to noah’</em>.</li>
 <li><tt class="docutils literal"><span class="pre">rt</span> <span class="pre">12</span></tt> will retweet the tweet with <em>[id=12]</em>. You can see id of
 each tweet beside the time.</li>
+<li><tt class="docutils literal"><span class="pre">quote</span> <span class="pre">12</span></tt> will quote the tweet with <em>[id=12]</em>. If no extra text is added,
+the quote will be cancelled.</li>
 <li><tt class="docutils literal"><span class="pre">allrt</span> <span class="pre">12</span> <span class="pre">20</span></tt> will list 20 newest retweets of the tweet with <em>[id=12]</em>. If the number of retweets is not specified, 5 newest retweets will be listed instead.</li>
 <li><tt class="docutils literal"><span class="pre">rep</span> <span class="pre">12</span> <span class="pre">Really</span></tt> will reply <em>‘Really’</em> to the tweet with <em>[id=12]</em>.</li>
 <li><tt class="docutils literal"><span class="pre">fav</span> <span class="pre">12</span></tt> will favorite the tweet with <em>[id=12]</em>.</li>
 <li><tt class="docutils literal"><span class="pre">allrt</span> <span class="pre">12</span> <span class="pre">20</span></tt> will list 20 newest retweets of the tweet with <em>[id=12]</em>. If the number of retweets is not specified, 5 newest retweets will be listed instead.</li>
 <li><tt class="docutils literal"><span class="pre">rep</span> <span class="pre">12</span> <span class="pre">Really</span></tt> will reply <em>‘Really’</em> to the tweet with <em>[id=12]</em>.</li>
 <li><tt class="docutils literal"><span class="pre">fav</span> <span class="pre">12</span></tt> will favorite the tweet with <em>[id=12]</em>.</li>
@@ -129,6 +138,8 @@ each tweet beside the time.</li>
 <li><tt class="docutils literal"><span class="pre">del</span> <span class="pre">12</span></tt> will delete tweet with <em>[id=12]</em>.</li>
 <li><tt class="docutils literal"><span class="pre">show</span> <span class="pre">image</span> <span class="pre">12</span></tt> will show the image in tweet with <em>[id=12]</em> in your
 OS’s image viewer.</li>
 <li><tt class="docutils literal"><span class="pre">del</span> <span class="pre">12</span></tt> will delete tweet with <em>[id=12]</em>.</li>
 <li><tt class="docutils literal"><span class="pre">show</span> <span class="pre">image</span> <span class="pre">12</span></tt> will show the image in tweet with <em>[id=12]</em> in your
 OS’s image viewer.</li>
+<li><tt class="docutils literal"><span class="pre">open</span> <span class="pre">12</span></tt> will open url in tweet with <em>[id=12]</em> in your
+OS’s default browser.</li>
 </ul>
 <p><strong>Direct Messages Commands</strong></p>
 <ul class="simple">
 </ul>
 <p><strong>Direct Messages Commands</strong></p>
 <ul class="simple">
@@ -153,6 +164,21 @@ you).</li>
 <li><tt class="docutils literal"><span class="pre">unblock</span> <span class="pre">&#64;dtvd88</span></tt> will unblock &#64;dtvd88.</li>
 <li><tt class="docutils literal"><span class="pre">report</span> <span class="pre">&#64;dtvd88</span></tt> will report &#64;dtvd88 as a spam account.</li>
 </ul>
 <li><tt class="docutils literal"><span class="pre">unblock</span> <span class="pre">&#64;dtvd88</span></tt> will unblock &#64;dtvd88.</li>
 <li><tt class="docutils literal"><span class="pre">report</span> <span class="pre">&#64;dtvd88</span></tt> will report &#64;dtvd88 as a spam account.</li>
 </ul>
+<p><strong>Twitter list</strong></p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">list</span></tt> will show all lists you are belong to.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">home</span></tt> will show timeline of list. You will be asked for list&#8217;s name.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">all_mem</span></tt> will show list&#8217;s all members.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">all_sub</span></tt> will show list&#8217;s all subscribers.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">add</span></tt> will add specific person to a list owned by you.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">rm</span></tt> will remove specific person from a list owned by you.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">sub</span></tt> will subscribe you to a specific list.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">unsub</span></tt> will unsubscribe you from a specific list.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">own</span></tt> will show all list owned by you.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">new</span></tt> will create a new list.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">update</span></tt> will update a list owned by you.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">del</span></tt> will delete a list owned by you.</li>
+</ul>
 <p><strong>Switching Stream Commands</strong></p>
 <ul>
 <li><p class="first"><tt class="docutils literal"><span class="pre">switch</span> <span class="pre">public</span> <span class="pre">#AKB48</span></tt> will switch current stream to public stream
 <p><strong>Switching Stream Commands</strong></p>
 <ul>
 <li><p class="first"><tt class="docutils literal"><span class="pre">switch</span> <span class="pre">public</span> <span class="pre">#AKB48</span></tt> will switch current stream to public stream
@@ -179,29 +205,121 @@ and <tt class="docutils literal"><span class="pre">-d</span></tt> will work as w
 </ul>
 </li>
 </ul>
 </ul>
 </li>
 </ul>
+<p><strong>Config Management</strong></p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">theme</span></tt> will list available themes.</li>
+</ul>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">theme</span> <span class="pre">monokai</span></tt> will apply <em>monokai</em> theme immedaitely.</li>
+<li><tt class="docutils literal"><span class="pre">theme</span> <span class="pre">current_as_default</span></tt> will remember current theme as next time default.</li>
+</ul>
+</div></blockquote>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">config</span></tt> will list all config key.</li>
+</ul>
+<blockquote>
+<div><ul class="simple">
+<li><tt class="docutils literal"><span class="pre">config</span> <span class="pre">ASCII_ART</span></tt> will output current value of <em>ASCII_ART</em> config key.</li>
+<li><tt class="docutils literal"><span class="pre">config</span> <span class="pre">ASCII_ART</span> <span class="pre">default</span></tt> will output default value of <em>ASCII_ART</em> config key.</li>
+<li><tt class="docutils literal"><span class="pre">config</span> <span class="pre">ASCII_ART</span> <span class="pre">=</span> <span class="pre">False</span></tt> will set value of <em>ASCII_ART</em> config key to <em>False</em>.</li>
+</ul>
+</div></blockquote>
 <p><strong>Screening Commands</strong></p>
 <ul class="simple">
 <li><tt class="docutils literal"><span class="pre">h</span></tt> will show the help.</li>
 <li><tt class="docutils literal"><span class="pre">c</span></tt> will clear the screen.</li>
 <li><tt class="docutils literal"><span class="pre">q</span></tt> will quit.</li>
 </ul>
 <p><strong>Screening Commands</strong></p>
 <ul class="simple">
 <li><tt class="docutils literal"><span class="pre">h</span></tt> will show the help.</li>
 <li><tt class="docutils literal"><span class="pre">c</span></tt> will clear the screen.</li>
 <li><tt class="docutils literal"><span class="pre">q</span></tt> will quit.</li>
 </ul>
-<p>For example see the screenshot above.</p>
+<p>Available commands are listed in <a href="#id3"><span class="problematic" id="id4">`Read The Docs`_</span></a>.</p>
 </div>
 </div>
+<div class="section" id="theme-customization">
+<h2>Theme customization<a class="headerlink" href="#theme-customization" title="Permalink to this headline">¶</a></h2>
+<p>Rainbow Stream is shipped with some default themes.
+You can either change theme by <tt class="docutils literal"><span class="pre">theme</span></tt> command or create your favorite one.</p>
+<p>Theme’s screenshot:</p>
+<ul class="simple">
+<li>Monokai</li>
+</ul>
+<div class="figure">
+<img alt="monokai" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png" />
 </div>
 </div>
-<div class="section" id="bug-and-feature-requests">
-<h1>Bug and feature requests<a class="headerlink" href="#bug-and-feature-requests" title="Permalink to this headline">¶</a></h1>
-<p>Found a bug or a feature request ?
-Please <a class="reference external" href="https://github.com/DTVD/rainbowstream/issues/new">create an issue</a> or contact me at <a class="reference external" href="https://twitter.com/dtvd88">&#64;dtvd88</a></p>
+<ul class="simple">
+<li>Solarized</li>
+</ul>
+<div class="figure">
+<img alt="solarized" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png" />
 </div>
 </div>
-<div class="section" id="contributing">
-<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
-<p>I appreciate any help and support. Feel free to <a class="reference external" href="https://github.com/DTVD/rainbowstream/fork">fork</a> and <a class="reference external" href="https://github.com/DTVD/rainbowstream/compare/">create a pull request</a>.
-You will be listed as contributor.</p>
+<ul class="simple">
+<li>Tomorrow Night</li>
+</ul>
+<div class="figure">
+<img alt="tomorrownight" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png" />
+</div>
+<ul class="simple">
+<li>Larapaste</li>
+</ul>
+<div class="figure">
+<img alt="larapaste" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png" />
 </div>
 </div>
-<div class="section" id="license">
-<h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1>
-<p>Rainbow Stream are released under an MIT License. See LICENSE.txt for
-details</p>
+<p>For detaile information, see <a class="reference external" href="https://github.com/DTVD/rainbowstream/blob/master/theme.md">theme usage and customization</a>.</p>
+</div>
+<div class="section" id="config-explanation">
+<h2>Config explanation<a class="headerlink" href="#config-explanation" title="Permalink to this headline">¶</a></h2>
+<p>Rainbow Stream has a config file located at <tt class="docutils literal"><span class="pre">~/.rainbow_config.json</span></tt>.
+You can view or set a new value of every config key by <tt class="docutils literal"><span class="pre">config</span></tt> command (See <strong>Interactive mode</strong> section above).</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">THEME</span></tt>: current theme.</li>
+<li><tt class="docutils literal"><span class="pre">ASCII_ART</span></tt>: diplay your twitter name by ascii art at stream begin or not.</li>
+<li><tt class="docutils literal"><span class="pre">SEARCH_MAX_RECORD</span></tt>: max tweets can display on &#8216;search&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">HOME_TWEET_NUM</span></tt>: default tweets to display on &#8216;home&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">RETWEETS_SHOW_NUM</span></tt>: default tweets to display on &#8216;allrt&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">MESSAGES_DISPLAY</span></tt>: default messages to display on &#8216;inbox&#8217; or &#8216;sent&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">TREND_MAX</span></tt>: default trends to display on &#8216;trend&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">LIST_MAX</span></tt>: default tweets to display on &#8216;list home&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">ONLY_LIST</span></tt>: filter list on &#8216;switch&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">IGNORE_LIST</span></tt>: ignore list on &#8216;switch&#8217; command.</li>
+<li><tt class="docutils literal"><span class="pre">HISTORY_FILENAME</span></tt>: name of file which stores input history.</li>
+<li><tt class="docutils literal"><span class="pre">IMAGE_SHIFT</span></tt>: left and right margin of image in &#8216;-iot&#8217;/&#8217;&#8211;image-on-term&#8217; mode.</li>
+<li><tt class="docutils literal"><span class="pre">IMAGE_MAX_HEIGHT</span></tt>: max height of image in &#8216;-iot&#8217;/&#8217;&#8211;image-on-term&#8217; mode.</li>
+<li><tt class="docutils literal"><span class="pre">USER_DOMAIN</span></tt>: user URL of Twitter Streaming API.</li>
+<li><tt class="docutils literal"><span class="pre">PUBLIC_DOMAIN</span></tt>: public URL of Twitter Streaming API.</li>
+<li><tt class="docutils literal"><span class="pre">SITE_DOMAIN</span></tt>: site URL of Twitter Streaming API.</li>
+</ul>
+</div>
+</div>
+<div class="section" id="development">
+<h1>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
+<p>If you want to build a runnable version yourself, follow these simple
+steps</p>
+<ul>
+<li><p class="first"><a class="reference external" href="https://apps.twitter.com/app/new">Create your own Twitter Application</a></p>
+</li>
+<li><p class="first">Get your Twitter application’s API key and secret</p>
+</li>
+<li><p class="first">Fork github&#8217;s repo and clone in your system.</p>
+</li>
+<li><p class="first">Create a file <tt class="docutils literal"><span class="pre">consumer.py</span></tt> in <a href="#id1"><span class="problematic" id="id2">``</span></a><a href="#id5"><span class="problematic" id="id6">`rainbowstream```_</span></a> folder with
+following content</p>
+<div class="code python highlight-python"><div class="highlight"><pre><span class="c"># Consumer information</span>
+<span class="n">CONSUMER_KEY</span> <span class="o">=</span> <span class="s">&#39;APIKey&#39;</span> <span class="c"># Your Twitter application&#39;s API key</span>
+<span class="n">CONSUMER_SECRET</span> <span class="o">=</span> <span class="s">&#39;APISecret&#39;</span> <span class="c"># Your Twitter application&#39;s API secret</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Use pip to install in local</p>
+<div class="code bash highlight-python"><div class="highlight"><pre># cd to directory which contains setup.py (cloned directory)
+virtualenv venv # Python3 users: use -p to specify python3
+source venv/bin/activate
+pip install -e .
+which rainbowstream # /this-directory/venv/bin/rainbowstream
+pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
+# Remove ~/.rainbow_oauth if exists
+rainbowstream # local version of rainbowstream
+</pre></div>
+</div>
+</li>
+</ul>
 </div>
 
 
 </div>
 
 
@@ -213,18 +331,25 @@ details</p>
   <h3><a href="#">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">Rainbow Stream</a></li>
   <h3><a href="#">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">Rainbow Stream</a></li>
-<li><a class="reference internal" href="#showcase">Showcase</a></li>
-<li><a class="reference internal" href="#install">Install</a></li>
+<li><a class="reference internal" href="#install">Install</a><ul>
+<li><a class="reference internal" href="#the-quick-way">The quick way</a></li>
+<li><a class="reference internal" href="#the-recommended-way">The recommended way</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#usage">Usage</a><ul>
 <li><a class="reference internal" href="#the-stream">The stream</a></li>
 <li><a class="reference internal" href="#the-interactive-mode">The interactive mode</a></li>
 <li><a class="reference internal" href="#usage">Usage</a><ul>
 <li><a class="reference internal" href="#the-stream">The stream</a></li>
 <li><a class="reference internal" href="#the-interactive-mode">The interactive mode</a></li>
+<li><a class="reference internal" href="#theme-customization">Theme customization</a></li>
+<li><a class="reference internal" href="#config-explanation">Config explanation</a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li><a class="reference internal" href="#bug-and-feature-requests">Bug and feature requests</a></li>
-<li><a class="reference internal" href="#contributing">Contributing</a></li>
-<li><a class="reference internal" href="#license">License</a></li>
+<li><a class="reference internal" href="#development">Development</a></li>
+</ul>
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="#">Documentation overview</a><ul>
+  </ul></li>
 </ul>
 </ul>
-
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/index.txt"
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="_sources/index.txt"
@@ -247,18 +372,12 @@ details</p>
       </div>
       <div class="clearer"></div>
     </div>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related">
-      <h3>Navigation</h3>
-      <ul>
-        <li class="right" style="margin-right: 10px">
-          <a href="genindex.html" title="General Index"
-             >index</a></li>
-        <li><a href="#">Rainbow Stream 0.1.0 documentation</a> &raquo;</li> 
-      </ul>
-    </div>
-    <div class="footer">
-        &copy; Copyright 2014, Vu Nhat Minh.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
-    </div>
+  <div class="footer">
+    &copy; Copyright 2014, Vu Nhat Minh.
+    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
+  </div>
+  
+  </div>
+  
   </body>
 </html>
\ No newline at end of file
   </body>
 </html>
\ No newline at end of file