Rainbow Stream\r
--------------\r
\r
-|Download| |Version|\r
+.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
+ :target: https://pypi.python.org/pypi/rainbowstream\r
+\r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+ :target: https://pypi.python.org/pypi/rainbowstream\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
-API`_.\r
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
\r
-Screenshot\r
+Showcase\r
----------\r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
+\r
+Screenshot: \r
\r
-|rainbowstream| |rainbowstreamIOT|\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
\r
Install\r
-------\r
\r
and see your stream.\r
\r
-I shipped a feature which can display **tweet’s images directly on\r
-terminal**. You can try it with:\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
\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
+number to the terminal, the rainbow will start.\r
\r
The interactive mode\r
^^^^^^^^^^^^^^^^^^^^\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
+Here is full list of supported command:\r
\r
-**Action Commands**\r
+**Explore Commands**\r
\r
- ``trend`` will show global trending topics. ``trend US`` will show\r
trends in United States while ``trend JP Tokyo`` will show trends in\r
- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
tweets.\r
\r
+- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
+ mention tweets.\r
+\r
+- ``whois @dtvd88`` will show profile of @dtvd88.\r
+\r
- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
exactly 9 tweets.\r
\r
-- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
- mention tweets.\r
+- ``s #noah`` will search the word *‘noah’*. Result will come back with\r
+ highlight.\r
+\r
+**Tweet Commands**\r
\r
- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
rainbow is god’s promise to noah’*.\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
+- ``fav 12`` will favorite the 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 with\r
- highlight.\r
-\r
-- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
+- ``del 12`` will delete tweet with *[id=12]*.\r
\r
- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
OS’s image viewer.\r
\r
-- ``ls fl`` will list all your followers (people who are following\r
- you).\r
-\r
-- ``ls fr`` will list all your friends (people who you are following).\r
+**Direct Messages Commands**\r
\r
- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
messages.\r
- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
messages.\r
\r
+- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
+\r
- ``trash 5`` will remove message with *[message\_id=5]*\r
\r
-- ``whois @dtvd88`` will show profile of @dtvd88.\r
+**Friends and followers Commands**\r
+\r
+- ``ls fl`` will list all your followers (people who are following\r
+ you).\r
+\r
+- ``ls fr`` will list all your friends (people who you are following).\r
\r
- ``fl @dtvd88`` will follow @dtvd88.\r
\r
- ``ufl @dtvd88`` will unfollow @dtvd88.\r
\r
+- ``mute @dtvd88`` will mute @dtvd88.\r
+\r
+- ``unmute @dtvd88`` will unmute @dtvd88.\r
+\r
+- ``muting`` will list muting users.\r
+\r
+- ``block @dtvd88`` will block @dtvd88.\r
+\r
+- ``unblock @dtvd88`` will unblock @dtvd88.\r
+\r
+- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
+\r
+**Screening Commands**\r
+\r
- ``h`` will show the help.\r
\r
- ``c`` will clear the screen.\r
\r
- ``q`` will quit.\r
\r
-**Stream Commands**\r
+**Switching Stream Commands**\r
\r
- ``switch public #AKB48`` will switch current stream to public stream\r
and track keyword ``AKB48``\r
- ``switch mine`` will switch current stream to personal stream. ``-f``\r
and ``-d`` will work as well.\r
\r
+\r
+\r
For example see the screenshot above.\r
\r
Bug Report\r
----------\r
\r
-Please `create an issue`_ or contact me at\r
-[@dtvd88](https://twitter.com/dtvd88)\r
+Please `create an issue`_ or contact me at `@dtvd88`_\r
\r
License\r
-------\r
\r
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
+.. _EarthQuake: https://github.com/jugyo/earthquake\r
.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
-\r
-.. |Download| image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
- :target: https://pypi.python.org/pypi/rainbowstream\r
-.. |Version| image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
- :target: https://pypi.python.org/pypi/rainbowstream\r
-.. |rainbowstream| image:: ./screenshot/RainbowStream.png\r
-.. |rainbowstreamIOT| image:: ./screenshot/RainbowStreamIOT.png
\ No newline at end of file
+.. _@dtvd88: https://twitter.com/dtvd88\r
projects / rainbowstream.git / blobdiff