# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 76c30e765086a1f7de37330ca968d2f0
+config: 5f094ae5f3ac404e1a1e240aafa39960
tags: 645f666f9bcd5a90fca523b33c5a78b7
Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
favorite … and much more fun directly from terminal.\r
\r
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
-\r
-Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
-\r
-Screenshot: \r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
- :alt: rainbowstream\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
- :alt: rainbowstreamIOT\r
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
+can run on Python 2.7.x and 3.x .\r
\r
Install\r
-------\r
\r
-You will need Python 2.7+ and pip.\r
+The quick way\r
+^^^^^^^^^^^^^\r
+\r
+You will need Python and pip (2.7.x or 3.x).\r
\r
.. code:: bash\r
\r
sudo pip install rainbowstream\r
- \r
-or try with a virtualenv\r
+ # Python 3 users: sudo pip3 install rainbowstream\r
+\r
+The recommended way\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+Use `virtualenv`_\r
\r
.. code:: bash\r
\r
- sudo pip install virtualenv # skip if you already have virtualenv\r
- virtualenv venv \r
- source venv/bin/activate # use the brand new virtualenv.\r
+ virtualenv venv\r
+ # Python 3 users : use -p to specify your Python 3 localtion as below\r
+ # virtualenv -p /usr/bin/python3 venv\r
+ source venv/bin/activate\r
pip install rainbowstream\r
\r
+\r
Usage\r
-----\r
\r
\r
.. code:: bash\r
\r
- rainbow\r
+ rainbowstream\r
\r
and see your stream.\r
\r
\r
.. code:: bash\r
\r
- rainbow -iot # Or rainbow --image-on-term\r
+ rainbowstream -iot # Or rainbowstream --image-on-term\r
\r
In the first time you will be asked for authorization of Rainbow Stream\r
app at Twitter. Just click the “Authorize access” button and paste PIN\r
- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
exactly 9 tweets.\r
\r
-- ``s #noah`` will search the word *‘noah’*. Result will come back with\r
- highlight.\r
+- ``s noah`` will search the word *‘noah’*. Result will come back with\r
+ highlight. Search can be performed with or without hashtag.\r
\r
**Tweet Commands**\r
\r
- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
each tweet beside the time.\r
\r
+- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
+ the quote will be cancelled.\r
+\r
- ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
\r
- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
OS’s image viewer.\r
\r
+- ``open 12`` will open url in tweet with *[id=12]* in your\r
+ OS’s default browser.\r
+\r
**Direct Messages Commands**\r
\r
- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
\r
- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
\r
+**Twitter list**\r
+\r
+- ``list`` will show all lists you are belong to.\r
+\r
+- ``list home`` will show timeline of list. You will be asked for list's name.\r
+\r
+- ``list all_mem`` will show list's all members.\r
+\r
+- ``list all_sub`` will show list's all subscribers.\r
+\r
+- ``list add`` will add specific person to a list owned by you.\r
+\r
+- ``list rm`` will remove specific person from a list owned by you.\r
+\r
+- ``list sub`` will subscribe you to a specific list.\r
+\r
+- ``list unsub`` will unsubscribe you from a specific list.\r
+\r
+- ``list own`` will show all list owned by you.\r
+\r
+- ``list new`` will create a new list.\r
+\r
+- ``list update`` will update a list owned by you.\r
+\r
+- ``list del`` will delete a list owned by you.\r
+\r
**Switching Stream Commands**\r
\r
- ``switch public #AKB48`` will switch current stream to public stream\r
+ Even ``cal`` will show the calendar for current month.\r
+ Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
\r
+**Config Management**\r
+\r
+- ``theme`` will list available themes.\r
+\r
+ + ``theme monokai`` will apply *monokai* theme immedaitely.\r
+ + ``theme current_as_default`` will remember current theme as next time default.\r
+\r
+- ``config`` will list all config key.\r
+\r
+ + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
+ + ``config ASCII_ART default`` will output default value of *ASCII_ART* config key.\r
+ + ``config ASCII_ART = False`` will set value of *ASCII_ART* config key to *False*.\r
+\r
**Screening Commands**\r
\r
- ``h`` will show the help.\r
\r
- ``q`` will quit.\r
\r
+Available commands are listed in `Read The Docs`_.\r
\r
-For example see the screenshot above.\r
+Theme customization\r
+^^^^^^^^^^^^^^^^^^^\r
\r
-Bug and feature requests\r
-------------------------\r
+Rainbow Stream is shipped with some default themes.\r
+You can either change theme by ``theme`` command or create your favorite one.\r
\r
-Found a bug or a feature request ? \r
-Please `create an issue`_ or contact me at `@dtvd88`_\r
+Theme’s screenshot:\r
\r
-Contributing\r
-------------\r
-I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
-You will be listed as contributor.\r
+- Monokai\r
\r
-License\r
--------\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
+ :alt: monokai\r
+\r
+- Solarized\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
+ :alt: solarized\r
+\r
+- Tomorrow Night\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+ :alt: tomorrownight\r
+\r
+- Larapaste\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+ :alt: larapaste\r
+\r
+For detaile information, see `theme usage and customization`_.\r
+\r
+Config explanation\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
+You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
+\r
+- ``THEME``: current theme.\r
+\r
+- ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
+\r
+- ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
+\r
+- ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
+\r
+- ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
+\r
+- ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
+\r
+- ``TREND_MAX``: default trends to display on 'trend' command.\r
+\r
+- ``LIST_MAX``: default tweets to display on 'list home' command.\r
+\r
+- ``ONLY_LIST``: filter list on 'switch' command.\r
+\r
+- ``IGNORE_LIST``: ignore list on 'switch' command.\r
+\r
+- ``HISTORY_FILENAME``: name of file which stores input history.\r
+\r
+- ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
+\r
+- ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
+\r
+- ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
+\r
+- ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
+\r
+- ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
+\r
+Development\r
+-----------\r
+\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
+\r
+- `Create your own Twitter Application`_\r
+- Get your Twitter application’s API key and secret\r
+- Fork github's repo and clone in your system.\r
+- Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
+ following content\r
+\r
+ .. code:: python\r
+\r
+ # Consumer information\r
+ CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
+ CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
+\r
+- Use pip to install in local\r
\r
-Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
-details\r
+ .. code:: bash\r
\r
+ # cd to directory which contains setup.py (cloned directory)\r
+ virtualenv venv # Python3 users: use -p to specify python3\r
+ source venv/bin/activate\r
+ pip install -e .\r
+ which rainbowstream # /this-directory/venv/bin/rainbowstream\r
+ pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
+ # Remove ~/.rainbow_oauth if exists\r
+ rainbowstream # local version of rainbowstream\r
\r
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
+.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
-.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
-.. _@dtvd88: https://twitter.com/dtvd88\r
-.. _fork: https://github.com/DTVD/rainbowstream/fork\r
-.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
+.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Index — Rainbow Stream 0.1.0 documentation</title>
+ <title>Index — 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: './',
- VERSION: '0.1.0',
+ VERSION: '0.4.3',
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>
- <link rel="top" title="Rainbow Stream 0.1.0 documentation" href="index.html" />
+ <link rel="top" title="RainbowStream 0.4.3 documentation" href="index.html" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
</head>
<body>
+
+
+
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
- <li><a href="index.html">Rainbow Stream 0.1.0 documentation</a> »</li>
+ <li><a href="index.html">RainbowStream 0.4.3 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
-
+ <h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
</div>
<div class="clearer"></div>
</div>
- <div class="related">
- <h3>Navigation</h3>
- <ul>
- <li class="right" style="margin-right: 10px">
- <a href="#" title="General Index"
- >index</a></li>
- <li><a href="index.html">Rainbow Stream 0.1.0 documentation</a> »</li>
- </ul>
- </div>
- <div class="footer">
- © Copyright 2014, Vu Nhat Minh.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
- </div>
+ <div class="footer">
+ © Copyright 2014, Vu Nhat Minh.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
+ </div>
+
</body>
</html>
\ No newline at end of file
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Rainbow Stream — Rainbow Stream 0.1.0 documentation</title>
+ <title>Rainbow Stream — 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: './',
- VERSION: '0.1.0',
+ VERSION: '0.4.3',
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>
- <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>
+
+
+ <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>
- <li><a href="#">Rainbow Stream 0.1.0 documentation</a> »</li>
+ <li><a href="#">RainbowStream 0.4.3 documentation</a> »</li>
</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>
-<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>
-<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
+# Python 3 users: sudo pip3 install rainbowstream
</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>
+</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="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’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
<li><tt class="docutils literal"><span class="pre">whois</span> <span class="pre">@dtvd88</span></tt> will show profile of @dtvd88.</li>
<li><tt class="docutils literal"><span class="pre">view</span> <span class="pre">@mdo</span></tt> will show @mdo ’s timeline. <tt class="docutils literal"><span class="pre">view</span> <span class="pre">@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">
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">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">
<li><tt class="docutils literal"><span class="pre">unblock</span> <span class="pre">@dtvd88</span></tt> will unblock @dtvd88.</li>
<li><tt class="docutils literal"><span class="pre">report</span> <span class="pre">@dtvd88</span></tt> will report @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’s name.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">all_mem</span></tt> will show list’s all members.</li>
+<li><tt class="docutils literal"><span class="pre">list</span> <span class="pre">all_sub</span></tt> will show list’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
</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>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 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 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">@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 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 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 ‘search’ command.</li>
+<li><tt class="docutils literal"><span class="pre">HOME_TWEET_NUM</span></tt>: default tweets to display on ‘home’ command.</li>
+<li><tt class="docutils literal"><span class="pre">RETWEETS_SHOW_NUM</span></tt>: default tweets to display on ‘allrt’ command.</li>
+<li><tt class="docutils literal"><span class="pre">MESSAGES_DISPLAY</span></tt>: default messages to display on ‘inbox’ or ‘sent’ command.</li>
+<li><tt class="docutils literal"><span class="pre">TREND_MAX</span></tt>: default trends to display on ‘trend’ command.</li>
+<li><tt class="docutils literal"><span class="pre">LIST_MAX</span></tt>: default tweets to display on ‘list home’ command.</li>
+<li><tt class="docutils literal"><span class="pre">ONLY_LIST</span></tt>: filter list on ‘switch’ command.</li>
+<li><tt class="docutils literal"><span class="pre">IGNORE_LIST</span></tt>: ignore list on ‘switch’ 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 ‘-iot’/’–image-on-term’ mode.</li>
+<li><tt class="docutils literal"><span class="pre">IMAGE_MAX_HEIGHT</span></tt>: max height of image in ‘-iot’/’–image-on-term’ 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’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">'APIKey'</span> <span class="c"># Your Twitter application's API key</span>
+<span class="n">CONSUMER_SECRET</span> <span class="o">=</span> <span class="s">'APISecret'</span> <span class="c"># Your Twitter application'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>
<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="#theme-customization">Theme customization</a></li>
+<li><a class="reference internal" href="#config-explanation">Config explanation</a></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>
-
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
</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> »</li>
- </ul>
- </div>
- <div class="footer">
- © Copyright 2014, Vu Nhat Minh.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
- </div>
+ <div class="footer">
+ © 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
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Search — Rainbow Stream 0.1.0 documentation</title>
+ <title>Search — 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: './',
- VERSION: '0.1.0',
+ VERSION: '0.4.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
- <link rel="top" title="Rainbow Stream 0.1.0 documentation" href="index.html" />
+ <link rel="top" title="RainbowStream 0.4.3 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script type="text/javascript" id="searchindexloader"></script>
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
</head>
<body>
+
+
+
<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="index.html">Rainbow Stream 0.1.0 documentation</a> »</li>
+ <li><a href="index.html">RainbowStream 0.4.3 documentation</a> »</li>
</ul>
</div>
</div>
</div>
<div class="sphinxsidebar">
- <div class="sphinxsidebarwrapper">
+ <div class="sphinxsidebarwrapper"><h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
</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="index.html">Rainbow Stream 0.1.0 documentation</a> »</li>
- </ul>
- </div>
- <div class="footer">
- © Copyright 2014, Vu Nhat Minh.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
- </div>
+ <div class="footer">
+ © Copyright 2014, Vu Nhat Minh.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
+ </div>
+
</body>
</html>
\ No newline at end of file
-Search.setIndex({envversion:42,terms:{all:0,newest:0,help:0,just:0,show:0,api:0,skip:0,unfollow:0,move:0,unfavorit:0,month:0,unblock:0,tweetstream:0,follow:0,profil:0,onli:0,noah:0,also:0,tweet:0,mute:0,activ:0,send:0,under:0,input:0,smart:0,bin:0,sourc:0,hit:0,python:0,watch:0,number:0,mention:0,promis:0,command:0,report:0,youtub:0,term:0,rainbowstream:0,like:0,anyth:0,realtim:0,button:0,list:0,ignore_list:0,"public":0,"try":0,screencast:0,arrow:0,each:0,found:0,remov:0,mean:0,pleas:0,www:0,mdo:0,trend:0,twitter:0,timelin:0,continu:0,realli:0,past:0,see:0,result:0,japan:0,home:0,calendar:0,histori:0,retweet:0,virtualenv:0,allrt:0,repli:0,rep:0,ufav:0,"while":0,access:0,delet:0,state:0,akb48:0,print:0,"new":0,message_id:0,iot:0,can:0,full:0,run:0,appreci:0,kei:0,screen:0,decid:0,here:0,fun:0,base:0,free:0,ask:0,come:0,search:0,current:0,filter:0,view:0,com:0,top:0,block:0,first:0,tykcvpmjq8:0,client:0,venv:0,simpli:0,directli:0,feel:0,appli:0,app:0,wahahaha:0,down:0,put:0,alreadi:0,global:0,inbox:0,contributor:0,txt:0,your:0,unit:0,enter:0,quit:0,from:0,pin:0,spam:0,support:0,compos:0,messag:0,avail:0,start:0,much:0,besid:0,includ:0,time:0,termin:0,type:0,friend:0,whoi:0,fork:0,shell:0,consol:0,peopl:0,brand:0,specifi:0,back:0,only_list:0,exactli:0,pull:0,account:0,word:0,have:0,keyword:0,tokyo:0,provid:0,setup:0,work:0,displai:0,dmo:0,calcul:0,del:0,sent:0,abov:0,cal:0,autocomplet:0,highlight:0,more:0,order_rainbow:0,tab:0,creat:0,viewer:0,favorit:0,sudo:0,mine:0,topic:0,dtvd88:0,explor:0,pip:0,ship:0,unmut:0,packag:0,readi:0,built:0,author:0,suggest:0,make:0,detail:0,who:0,click:0,random_rainbow:0,nick:0,need:0,exampl:0,ufl:0,which:0,instead:0,you:0,trash:0,config:0,imag:0,even:0,http:0,screenshot:0,track:0,fav:0,previou:0,tool:0,what:0,releas:0,user:0,eval:0,mit:0,ani:0,direct:0,clear:0,well:0,exclud:0,issu:0,person:0,"switch":0,contact:0,ignor:0,thi:0,god:0},objtypes:{},objnames:{},filenames:["index"],titles:["Rainbow Stream"],objects:{},titleterms:{rainbow:0,featur:0,contribut:0,stream:0,showcas:0,interact:0,usag:0,request:0,bug:0,mode:0,instal:0,licens:0}})
\ No newline at end of file
+Search.setIndex({envversion:42,terms:{all:0,newest:0,help:0,noah:0,show:0,skip:[],unfollow:0,consum:0,unfavorit:0,month:0,unblock:0,tweetstream:0,url:0,follow:0,config:[],larapast:0,content:0,onli:0,locat:0,just:0,explor:0,nick:0,tweet:0,mute:0,activ:0,send:0,only_list:0,add:0,akb48:0,tool:0,text:0,input:0,folder:0,local:0,smart:0,bin:0,applic:0,move:0,hit:0,which:0,unsubscrib:0,python:0,list_max:0,watch:[],wahahaha:0,repo:0,mention:0,promis:0,usr:0,instead:0,report:0,word:0,height:0,youtub:[],runnabl:0,python3:0,name:0,term:0,rainbowstream:0,like:0,specif:0,anyth:0,even:0,realtim:0,button:0,list:0,ignore_list:0,message_id:0,"try":0,provid:0,screencast:[],either:0,arrow:0,each:0,all_mem:0,found:[],manag:0,mean:0,pleas:[],shell:0,www:[],set:0,art:0,mdo:0,trend:0,twitter:0,timelin:0,some:0,continu:0,realli:0,past:0,contributor:[],see:0,previou:0,result:0,japan:0,home:0,calendar:0,dmo:0,retweet:0,appreci:[],virtualenv:0,allrt:0,friend:0,sub:0,mine:0,repli:0,rep:0,ufav:0,below:0,your:0,profil:0,delet:0,state:0,version:0,right:0,contact:[],print:0,"new":0,get:0,trend_max:0,"public":0,full:0,run:0,image_max_height:0,kei:0,retweets_show_num:0,screen:0,night:0,decid:0,here:0,consumer_secret:0,autocomplet:0,step:0,base:0,free:[],output:0,ask:0,come:0,ignor:0,valu:0,suggest:0,search:0,mit:[],god:0,current:0,fav:0,filter:0,person:0,public_domain:0,fals:0,chang:0,view:0,com:[],support:0,block:0,first:0,tykcvpmjq8:[],own:0,simpli:0,directli:0,extra:0,feel:[],appli:0,app:0,number:0,yourself:0,down:0,put:0,ascii_art:0,api:0,rainbow_config:0,inbox:0,json:0,cancel:0,diplai:0,txt:[],open:0,tomorrow:0,unit:0,quit:0,from:0,creat:0,spam:0,top:0,system:0,messag:0,next:0,avail:0,start:0,secret:0,much:0,besid:0,compos:0,subscrib:0,exampl:[],termin:0,type:0,store:0,includ:0,search_max_record:0,setup:0,site_domain:0,consol:0,apisecret:0,venv:0,peopl:0,brand:[],under:[],specifi:0,consumer_kei:0,solar:0,hashtag:0,alreadi:[],exactli:0,sent:0,pull:[],account:0,calcul:0,grep:0,have:[],keyword:0,tokyo:0,"default":0,remov:0,access:0,displai:0,section:0,histori:0,directori:0,"while":0,apikei:0,del:0,can:0,abov:0,cal:0,fun:0,highlight:0,more:0,margin:0,order_rainbow:0,browser:0,fork:0,messages_displai:0,want:0,pin:0,direct:0,viewer:0,image_shift:0,sudo:0,site:0,ani:[],topic:0,pip:0,sourc:0,exist:0,file:0,localt:0,dtvd88:0,everi:0,ship:0,work:0,ascii:0,well:0,packag:0,tab:0,readi:0,random_rainbow:0,built:0,pip3:0,author:0,perform:0,unmut:0,make:0,belong:0,detail:0,who:0,click:0,member:0,also:0,need:0,client:0,ufl:0,build:0,rememb:0,contain:0,global:0,current_as_default:0,trash:0,simpl:0,imag:0,updat:0,monokai:0,begin:0,http:[],time:0,screenshot:0,track:0,max:0,clone:0,iot:0,home_tweet_num:0,what:0,history_filenam:0,releas:[],user:0,eval:0,thi:0,unsub:0,rainbow_oauth:0,immedait:0,all_sub:0,github:0,whoi:0,read:0,doc:0,clear:0,quot:0,favorit:0,exclud:0,issu:[],inform:0,"switch":0,without:0,command:0,back:0,enter:0,user_domain:0,you:0,left:0},objtypes:{},objnames:{},filenames:["index"],titles:["Rainbow Stream"],objects:{},titleterms:{explan:0,rainbow:0,featur:[],develop:0,contribut:[],stream:0,showcas:[],interact:0,licens:[],usag:0,request:[],custom:0,theme:0,wai:0,mode:0,recommend:0,quick:0,instal:0,config:0,bug:[]}})
\ No newline at end of file
# -*- coding: utf-8 -*-
#
-# Rainbow Stream documentation build configuration file, created by
-# sphinx-quickstart on Mon Jun 30 17:12:05 2014.
+# RainbowStream documentation build configuration file, created by
+# sphinx-quickstart on Wed Jul 23 12:26:18 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
import sys
import os
+sys.path.append(os.path.abspath('_themes'))
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
master_doc = 'index'
# General information about the project.
-project = u'Rainbow Stream'
+project = u'RainbowStream'
copyright = u'2014, Vu Nhat Minh'
# The version info for the project you're documenting, acts as replacement for
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-sys.path.append(os.path.abspath('_themes'))
+#html_theme = 'default'
html_theme_path = ['_themes']
html_theme = 'flask'
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- ('index', 'RainbowStream.tex', u'Rainbow Stream Documentation',
+ ('index', 'RainbowStream.tex', u'RainbowStream Documentation',
u'Vu Nhat Minh', 'manual'),
]
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'rainbowstream', u'Rainbow Stream Documentation',
+ ('index', 'rainbowstream', u'RainbowStream Documentation',
[u'Vu Nhat Minh'], 1)
]
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- ('index', 'RainbowStream', u'Rainbow Stream Documentation',
+ ('index', 'RainbowStream', u'RainbowStream Documentation',
u'Vu Nhat Minh', 'RainbowStream', 'One line description of project.',
'Miscellaneous'),
]
projects / rainbowstream.git / commitdiff