sphinx docs
[rainbowstream.git] / docs / _build / html / index.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>Rainbow Stream &mdash; Rainbow Stream 0.1.0 documentation</title>
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
16 URL_ROOT: './',
17 VERSION: '0.1.0',
19 FILE_SUFFIX: '.html',
20 HAS_SOURCE: true
21 };
22 </script>
23 <script type="text/javascript" src="_static/jquery.js"></script>
24 <script type="text/javascript" src="_static/underscore.js"></script>
25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <link rel="top" title="Rainbow Stream 0.1.0 documentation" href="#" />
27 </head>
28 <body>
29 <div class="related">
30 <h3>Navigation</h3>
31 <ul>
32 <li class="right" style="margin-right: 10px">
33 <a href="genindex.html" title="General Index"
34 accesskey="I">index</a></li>
35 <li><a href="#">Rainbow Stream 0.1.0 documentation</a> &raquo;</li>
36 </ul>
37 </div>
39 <div class="document">
40 <div class="documentwrapper">
41 <div class="bodywrapper">
42 <div class="body">
44 <div class="section" id="rainbow-stream">
45 <h1>Rainbow Stream<a class="headerlink" href="#rainbow-stream" title="Permalink to this headline"></a></h1>
46 <a class="reference external image-reference" href="https://pypi.python.org/pypi/rainbowstream"><img alt="http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat" src="http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat" /></a>
47 <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>
48 <p>Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
49 favorite … and much more fun directly from terminal.</p>
50 <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>
51 </div>
52 <div class="section" id="showcase">
53 <h1>Showcase<a class="headerlink" href="#showcase" title="Permalink to this headline"></a></h1>
54 <p>Screencast: <a class="reference external" href="https://www.youtube.com/watch?v=tykCvPMJq8s">https://www.youtube.com/watch?v=tykCvPMJq8s</a></p>
55 <p>Screenshot:</p>
56 <div class="figure">
57 <img alt="rainbowstream" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png" />
58 </div>
59 <div class="figure">
60 <img alt="rainbowstreamIOT" src="https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png" />
61 </div>
62 </div>
63 <div class="section" id="install">
64 <h1>Install<a class="headerlink" href="#install" title="Permalink to this headline"></a></h1>
65 <p>You will need Python 2.7+ and pip.</p>
66 <div class="code bash highlight-python"><div class="highlight"><pre>sudo pip install rainbowstream
67 </pre></div>
68 </div>
69 <p>or try with a virtualenv</p>
70 <div class="code bash highlight-python"><div class="highlight"><pre>sudo pip install virtualenv # skip if you already have virtualenv
71 virtualenv venv
72 source venv/bin/activate # use the brand new virtualenv.
73 pip install rainbowstream
74 </pre></div>
75 </div>
76 </div>
77 <div class="section" id="usage">
78 <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h1>
79 <div class="section" id="the-stream">
80 <h2>The stream<a class="headerlink" href="#the-stream" title="Permalink to this headline"></a></h2>
81 <p>Just type</p>
82 <div class="code bash highlight-python"><div class="highlight"><pre><span class="n">rainbow</span>
83 </pre></div>
84 </div>
85 <p>and see your stream.</p>
86 <p>I shipped a feature which can display <strong>tweet&#8217;s images directly on terminal</strong>.
87 You can try it with:</p>
88 <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>
89 </pre></div>
90 </div>
91 <p>In the first time you will be asked for authorization of Rainbow Stream
92 app at Twitter. Just click the “Authorize access” button and paste PIN
93 number to the terminal, the rainbow will start.</p>
94 </div>
95 <div class="section" id="the-interactive-mode">
96 <h2>The interactive mode<a class="headerlink" href="#the-interactive-mode" title="Permalink to this headline"></a></h2>
97 <p>While your personal stream is continued, you are also ready to tweet,
98 search, reply, retweet… directly from console. Simply type “h” and hit
99 the Enter key to see the help.</p>
100 <p>Input is in interactive mode. It means that you can use arrow key to
101 move up and down history, tab-autocomplete or 2 tab to view available
102 suggestion. Input history from previous run is available as well.</p>
103 <p>Here is full list of supported command:</p>
104 <p><strong>Explore Commands</strong></p>
105 <ul class="simple">
106 <li><tt class="docutils literal"><span class="pre">trend</span></tt> will show global trending topics. <tt class="docutils literal"><span class="pre">trend</span> <span class="pre">US</span></tt> will show
107 trends in United States while <tt class="docutils literal"><span class="pre">trend</span> <span class="pre">JP</span> <span class="pre">Tokyo</span></tt> will show trends in
108 Tokyo/Japan.</li>
109 <li><tt class="docutils literal"><span class="pre">home</span></tt> will show your timeline. <tt class="docutils literal"><span class="pre">home</span> <span class="pre">10</span></tt> will print exactly 10
110 tweets.</li>
111 <li><tt class="docutils literal"><span class="pre">mentions</span></tt> will show mentions timeline. <tt class="docutils literal"><span class="pre">mentions</span> <span class="pre">7</span></tt> will show 7
112 mention tweets.</li>
113 <li><tt class="docutils literal"><span class="pre">whois</span> <span class="pre">&#64;dtvd88</span></tt> will show profile of &#64;dtvd88.</li>
114 <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
115 exactly 9 tweets.</li>
116 <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
117 highlight.</li>
118 </ul>
119 <p><strong>Tweet Commands</strong></p>
120 <ul class="simple">
121 <li><tt class="docutils literal"><span class="pre">t</span> <span class="pre">the</span> <span class="pre">rainbow</span> <span class="pre">is</span> <span class="pre">god's</span> <span class="pre">promise</span> <span class="pre">to</span> <span class="pre">noah</span></tt> will tweet exactly <em>‘the
122 rainbow is god’s promise to noah’</em>.</li>
123 <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
124 each tweet beside the time.</li>
125 <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>
126 <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>
127 <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>
128 <li><tt class="docutils literal"><span class="pre">ufav</span> <span class="pre">12</span></tt> will unfavorite tweet with <em>[id=12]</em>.</li>
129 <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>
130 <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
131 OS’s image viewer.</li>
132 </ul>
133 <p><strong>Direct Messages Commands</strong></p>
134 <ul class="simple">
135 <li><tt class="docutils literal"><span class="pre">inbox</span></tt> will show inbox messages. <tt class="docutils literal"><span class="pre">inbox</span> <span class="pre">7</span></tt> will show newest 7
136 messages.</li>
137 <li><tt class="docutils literal"><span class="pre">sent</span></tt> will show sent messages. <tt class="docutils literal"><span class="pre">sent</span> <span class="pre">7</span></tt> will show newest 7
138 messages.</li>
139 <li><tt class="docutils literal"><span class="pre">mes</span> <span class="pre">&#64;dtvd88</span> <span class="pre">hi</span></tt> will send a <tt class="docutils literal"><span class="pre">hi</span></tt> message to &#64;dtvd88.</li>
140 <li><tt class="docutils literal"><span class="pre">trash</span> <span class="pre">5</span></tt> will remove message with <em>[message_id=5]</em></li>
141 </ul>
142 <p><strong>Friends and followers Commands</strong></p>
143 <ul class="simple">
144 <li><tt class="docutils literal"><span class="pre">ls</span> <span class="pre">fl</span></tt> will list all your followers (people who are following
145 you).</li>
146 <li><tt class="docutils literal"><span class="pre">ls</span> <span class="pre">fr</span></tt> will list all your friends (people who you are following).</li>
147 <li><tt class="docutils literal"><span class="pre">fl</span> <span class="pre">&#64;dtvd88</span></tt> will follow &#64;dtvd88.</li>
148 <li><tt class="docutils literal"><span class="pre">ufl</span> <span class="pre">&#64;dtvd88</span></tt> will unfollow &#64;dtvd88.</li>
149 <li><tt class="docutils literal"><span class="pre">mute</span> <span class="pre">&#64;dtvd88</span></tt> will mute &#64;dtvd88.</li>
150 <li><tt class="docutils literal"><span class="pre">unmute</span> <span class="pre">&#64;dtvd88</span></tt> will unmute &#64;dtvd88.</li>
151 <li><tt class="docutils literal"><span class="pre">muting</span></tt> will list muting users.</li>
152 <li><tt class="docutils literal"><span class="pre">block</span> <span class="pre">&#64;dtvd88</span></tt> will block &#64;dtvd88.</li>
153 <li><tt class="docutils literal"><span class="pre">unblock</span> <span class="pre">&#64;dtvd88</span></tt> will unblock &#64;dtvd88.</li>
154 <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>
155 </ul>
156 <p><strong>Switching Stream Commands</strong></p>
157 <ul>
158 <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
159 and track keyword <tt class="docutils literal"><span class="pre">AKB48</span></tt></p>
160 </li>
161 <li><p class="first"><tt class="docutils literal"><span class="pre">switch</span> <span class="pre">public</span> <span class="pre">#AKB48</span> <span class="pre">-f</span></tt> will do exactly as above but will ask you
162 to provide 2 list:</p>
163 <p><tt class="docutils literal"><span class="pre">Only</span> <span class="pre">nicks</span></tt> decide what nicks will be include only.</p>
164 <p><tt class="docutils literal"><span class="pre">Ignore</span> <span class="pre">nicks</span></tt>decide what nicks will be exclude.</p>
165 </li>
166 <li><p class="first"><tt class="docutils literal"><span class="pre">switch</span> <span class="pre">public</span> <span class="pre">#AKB48</span> <span class="pre">-d</span></tt> will apply filter to <em>ONLY_LIST</em> and
167 <em>IGNORE_LIST</em>. You can setup 2 list above at <tt class="docutils literal"><span class="pre">config.py</span></tt></p>
168 </li>
169 <li><p class="first"><tt class="docutils literal"><span class="pre">switch</span> <span class="pre">mine</span></tt> will switch current stream to personal stream. <tt class="docutils literal"><span class="pre">-f</span></tt>
170 and <tt class="docutils literal"><span class="pre">-d</span></tt> will work as well.</p>
171 </li>
172 </ul>
173 <p><strong>Smart shell</strong></p>
174 <ul class="simple">
175 <li>Put anything to terminal, the app will try to eval and display result as a python interactive shell.<ul>
176 <li><tt class="docutils literal"><span class="pre">142857*2</span></tt> or <tt class="docutils literal"><span class="pre">101**3</span></tt> like a calculator.</li>
177 <li>Even <tt class="docutils literal"><span class="pre">cal</span></tt> will show the calendar for current month.</li>
178 <li>Put <tt class="docutils literal"><span class="pre">order_rainbow('anything')</span></tt> or <tt class="docutils literal"><span class="pre">random_rainbow('wahahaha')</span></tt> will make more fun :)</li>
179 </ul>
180 </li>
181 </ul>
182 <p><strong>Screening Commands</strong></p>
183 <ul class="simple">
184 <li><tt class="docutils literal"><span class="pre">h</span></tt> will show the help.</li>
185 <li><tt class="docutils literal"><span class="pre">c</span></tt> will clear the screen.</li>
186 <li><tt class="docutils literal"><span class="pre">q</span></tt> will quit.</li>
187 </ul>
188 <p>For example see the screenshot above.</p>
189 </div>
190 </div>
191 <div class="section" id="bug-and-feature-requests">
192 <h1>Bug and feature requests<a class="headerlink" href="#bug-and-feature-requests" title="Permalink to this headline"></a></h1>
193 <p>Found a bug or a feature request ?
194 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>
195 </div>
196 <div class="section" id="contributing">
197 <h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h1>
198 <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>.
199 You will be listed as contributor.</p>
200 </div>
201 <div class="section" id="license">
202 <h1>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
203 <p>Rainbow Stream are released under an MIT License. See LICENSE.txt for
204 details</p>
205 </div>
208 </div>
209 </div>
210 </div>
211 <div class="sphinxsidebar">
212 <div class="sphinxsidebarwrapper">
213 <h3><a href="#">Table Of Contents</a></h3>
214 <ul>
215 <li><a class="reference internal" href="#">Rainbow Stream</a></li>
216 <li><a class="reference internal" href="#showcase">Showcase</a></li>
217 <li><a class="reference internal" href="#install">Install</a></li>
218 <li><a class="reference internal" href="#usage">Usage</a><ul>
219 <li><a class="reference internal" href="#the-stream">The stream</a></li>
220 <li><a class="reference internal" href="#the-interactive-mode">The interactive mode</a></li>
221 </ul>
222 </li>
223 <li><a class="reference internal" href="#bug-and-feature-requests">Bug and feature requests</a></li>
224 <li><a class="reference internal" href="#contributing">Contributing</a></li>
225 <li><a class="reference internal" href="#license">License</a></li>
226 </ul>
228 <h3>This Page</h3>
229 <ul class="this-page-menu">
230 <li><a href="_sources/index.txt"
231 rel="nofollow">Show Source</a></li>
232 </ul>
233 <div id="searchbox" style="display: none">
234 <h3>Quick search</h3>
235 <form class="search" action="search.html" method="get">
236 <input type="text" name="q" />
237 <input type="submit" value="Go" />
238 <input type="hidden" name="check_keywords" value="yes" />
239 <input type="hidden" name="area" value="default" />
240 </form>
241 <p class="searchtip" style="font-size: 90%">
242 Enter search terms or a module, class or function name.
243 </p>
244 </div>
245 <script type="text/javascript">$('#searchbox').show(0);</script>
246 </div>
247 </div>
248 <div class="clearer"></div>
249 </div>
250 <div class="related">
251 <h3>Navigation</h3>
252 <ul>
253 <li class="right" style="margin-right: 10px">
254 <a href="genindex.html" title="General Index"
255 >index</a></li>
256 <li><a href="#">Rainbow Stream 0.1.0 documentation</a> &raquo;</li>
257 </ul>
258 </div>
259 <div class="footer">
260 &copy; Copyright 2014, Vu Nhat Minh.
261 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
262 </div>
263 </body>
264 </html>