--- /dev/null
+Rainbow Stream\r
+--------------\r
+\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 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
+\r
+Install\r
+-------\r
+\r
+You will need Python 2.7+ and pip.\r
+\r
+.. code:: bash\r
+\r
+ sudo pip install rainbowstream\r
+ \r
+or try with a 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
+ 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
+**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
+ Tokyo/Japan.\r
+\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
+- ``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
+\r
+- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
+ each tweet beside the time.\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
+\r
+- ``fav 12`` will favorite the tweet with *[id=12]*.\r
+\r
+- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
+\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
+**Direct Messages Commands**\r
+\r
+- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
+ messages.\r
+\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
+**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
+**Switching Stream Commands**\r
+\r
+- ``switch public #AKB48`` will switch current stream to public stream\r
+ 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
+**Smart shell**\r
+\r
+- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
+\r
+ + ``142857*2`` or ``101**3`` like a calculator.\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
+**Screening Commands**\r
+\r
+- ``h`` will show the help.\r
+\r
+- ``c`` will clear the screen.\r
+\r
+- ``q`` will quit.\r
+\r
+\r
+For example see the screenshot above.\r
+\r
+Bug and feature requests\r
+------------------------\r
+\r
+Found a bug or a feature request ? \r
+Please `create an issue`_ or contact me at `@dtvd88`_\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
+\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 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
projects / rainbowstream.git / blobdiff