Update README.rst

[rainbowstream.git] / README.rst

Rainbow Stream\r
--------------\r
\r
.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
   :target: https://pypi.python.org/pypi/rainbowstream/0.0.3\r
   \r
.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
   :target: https://pypi.python.org/pypi/rainbowstream/0.0.3\r
\r
Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
favorite … and much more fun directly from terminal.\r
\r
This package build on the top of `Python Twitter Tool`_ and `Twitter\r
Streaming API`_ and inspired by `EarthQuake`_\r
\r
Screenshot\r
----------\r
\r
.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
   :alt: v0.0.1\r
\r
.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
   :alt: v0.0.3\r
\r
Install\r
-------\r
\r
You will need Python 2.7+ and pip.\r
\r
.. code:: bash\r
\r
    pip install rainbowstream\r
\r
Usage\r
-----\r
\r
The stream\r
^^^^^^^^^^\r
\r
Just type\r
\r
.. code:: bash\r
\r
    rainbow\r
\r
and see your stream.\r
\r
I shipped a feature which can display **tweet's images directly on terminal**.\r
You can try it with:\r
\r
.. code:: bash\r
\r
    rainbow -iot # Or rainbow --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
number to the terminal, the rainbow will start.\r
\r
The interactive mode\r
^^^^^^^^^^^^^^^^^^^^\r
\r
While your personal stream is continued, you are also ready to tweet,\r
search, reply, retweet… directly from console. Simply type “h” and hit\r
the Enter key to see the help.\r
\r
Input is in interactive mode. It means that you can use arrow key to\r
move up and down history, tab-autocomplete or 2 tab to view available\r
suggestion. Input history from previous run is available as well.\r
\r
Here is full list of supported command\r
\r
**Stream Command**\r
\r
-  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
\r
-  ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
   to provide 2 list:\r
\r
   ``Only nicks`` decide what nicks will be include only.\r
\r
   ``Ignore nicks`` decide what nicks will be exclude.\r
\r
-  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
\r
-  ``switch mine`` will switch current stream to personal stream. ``-f``\r
   and ``-d`` will work as well.\r
\r
**Action Command**\r
\r
-  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
   tweet.\r
\r
-  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
   exactly 9 tweet.\r
\r
-  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
   rainbow is god’s promise to noah’*\r
\r
-  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
   each tweet beside the time.\r
\r
-  ``fav 12`` will favorite the tweet with *[id=12]*.\r
\r
-  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
\r
-  ``del 12`` will delete tweet with *[id=12]*.\r
\r
-  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
\r
-  ``s #noah`` will search the word *‘noah’*. Result will come back\r
   with highlight.\r
\r
-  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
\r
-  ``fl @dtvd88`` will follow @dtvd88.\r
\r
-  ``ufl @dtvd88`` will unfollow @dtvd88.\r
\r
-  ``h`` will show the help.\r
\r
-  ``c`` will clear the screen.\r
\r
-  ``q`` will quit.\r
\r
For example see the screenshot above.\r
\r
Bug Report\r
----------\r
\r
Please `create an issue`_ or contact me at `@dtvd88`_\r
\r
License\r
-------\r
\r
Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
details\r
\r
\r
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
.. _EarthQuake: https://github.com/jugyo/earthquake\r
.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
.. _@dtvd88: https://twitter.com/dtvd88\r