| 1 | Rainbow Stream\r |
| 2 | --------------\r |
| 3 | \r |
| 4 | Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r |
| 5 | favorite … and much more fun directly from terminal.\r |
| 6 | \r |
| 7 | This package build on the top of `Python Twitter Tool`_ and `Twitter\r |
| 8 | Streaming API`_ and inspired by `EarthQuake`_\r |
| 9 | \r |
| 10 | Screenshot\r |
| 11 | ----------\r |
| 12 | \r |
| 13 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png\r |
| 14 | :alt: v0.0.1\r |
| 15 | \r |
| 16 | \r |
| 17 | Install\r |
| 18 | -------\r |
| 19 | \r |
| 20 | You will need Python 2.7+ and pip.\r |
| 21 | \r |
| 22 | .. code:: bash\r |
| 23 | \r |
| 24 | pip install rainbowstream\r |
| 25 | \r |
| 26 | Usage\r |
| 27 | -----\r |
| 28 | \r |
| 29 | The stream\r |
| 30 | ^^^^^^^^^^\r |
| 31 | \r |
| 32 | Just type\r |
| 33 | \r |
| 34 | .. code:: bash\r |
| 35 | \r |
| 36 | rainbow\r |
| 37 | \r |
| 38 | and see your stream.\r |
| 39 | \r |
| 40 | In the first time you will be asked for authorization of Rainbow Stream\r |
| 41 | app at Twitter. Just click the “Authorize access” button and paste PIN\r |
| 42 | number to the terminal, the rainbow will start.\r |
| 43 | \r |
| 44 | The interactive mode\r |
| 45 | ^^^^^^^^^^^^^^^^^^^^\r |
| 46 | \r |
| 47 | While your personal stream is continued, you are also ready to tweet,\r |
| 48 | search, reply, retweet… directly from console. Simply type “h” and hit\r |
| 49 | the Enter key to see the help\r |
| 50 | \r |
| 51 | Input is in interactive mode. It means that you can use arrow key to\r |
| 52 | move up and down history, tab-autocomplete or 2 tab to view available\r |
| 53 | suggestion\r |
| 54 | \r |
| 55 | Here is full list of supported command\r |
| 56 | \r |
| 57 | **Stream Command** ** \r |
| 58 | \r |
| 59 | - ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r |
| 60 | \r |
| 61 | - ``switch public #AKB48 -f`` will do exactly as above but will ask you\r |
| 62 | to provide 2 list:\r |
| 63 | \r |
| 64 | ``Only nicks`` decide what nicks will be include only.\r |
| 65 | \r |
| 66 | ``Ignore nicks`` decide what nicks will be exclude.\r |
| 67 | \r |
| 68 | - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r |
| 69 | *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r |
| 70 | \r |
| 71 | - ``switch mine`` will switch current stream to personal stream. ``-f``\r |
| 72 | and ``-d`` will work as well.\r |
| 73 | \r |
| 74 | **Action Command**\r |
| 75 | \r |
| 76 | - ``home`` will show your timeline. ``home 10`` will print exactly 10\r |
| 77 | tweet.\r |
| 78 | \r |
| 79 | - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r |
| 80 | exactly 9 tweet.\r |
| 81 | \r |
| 82 | - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r |
| 83 | rainbow is god’s promise to noah’*\r |
| 84 | \r |
| 85 | - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r |
| 86 | each tweet beside the time.\r |
| 87 | \r |
| 88 | - ``fav 12`` will favorite the tweet with *[id=12]*.\r |
| 89 | \r |
| 90 | - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r |
| 91 | \r |
| 92 | - ``del 12`` will delete tweet with *[id=12]*.\r |
| 93 | \r |
| 94 | - ``ufav 12`` will unfavorite tweet with *[id=12]*.\r |
| 95 | \r |
| 96 | - ``s #noah`` will search the word *‘noah’*. Result will come back\r |
| 97 | with highlight.\r |
| 98 | \r |
| 99 | - ``fr`` will list all friend (You are following people).\r |
| 100 | \r |
| 101 | - ``fl`` will list all follower.\r |
| 102 | \r |
| 103 | - ``h`` will show the help.\r |
| 104 | \r |
| 105 | - ``c`` will clear the screen.\r |
| 106 | \r |
| 107 | - ``q`` will quit.\r |
| 108 | \r |
| 109 | For example see the screenshot above.\r |
| 110 | \r |
| 111 | Bug Report\r |
| 112 | ----------\r |
| 113 | \r |
| 114 | Please `create an issue`_ or contact me at\r |
| 115 | [@dtvd88](https://twitter.com/dtvd88)\r |
| 116 | \r |
| 117 | License\r |
| 118 | -------\r |
| 119 | \r |
| 120 | Rainbow Stream are released under an MIT License. See LICENSE.txt for\r |
| 121 | details\r |
| 122 | \r |
| 123 | \r |
| 124 | .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r |
| 125 | .. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r |
| 126 | .. _EarthQuake: https://github.com/jugyo/earthquake\r |
| 127 | .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r |