| 1 | Rainbow Stream\r |
| 2 | --------------\r |
| 3 | \r |
| 4 | .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r |
| 5 | :target: https://pypi.python.org/pypi/rainbowstream\r |
| 6 | \r |
| 7 | .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r |
| 8 | :target: https://pypi.python.org/pypi/rainbowstream\r |
| 9 | \r |
| 10 | Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r |
| 11 | favorite … and much more fun directly from terminal.\r |
| 12 | \r |
| 13 | This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r |
| 14 | \r |
| 15 | Screenshot\r |
| 16 | ----------\r |
| 17 | \r |
| 18 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r |
| 19 | :alt: rainbowstream\r |
| 20 | \r |
| 21 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r |
| 22 | :alt: rainbowstreamIOT\r |
| 23 | \r |
| 24 | Install\r |
| 25 | -------\r |
| 26 | \r |
| 27 | You will need Python 2.7+ and pip.\r |
| 28 | \r |
| 29 | .. code:: bash\r |
| 30 | \r |
| 31 | pip install rainbowstream\r |
| 32 | \r |
| 33 | Usage\r |
| 34 | -----\r |
| 35 | \r |
| 36 | The stream\r |
| 37 | ^^^^^^^^^^\r |
| 38 | \r |
| 39 | Just type\r |
| 40 | \r |
| 41 | .. code:: bash\r |
| 42 | \r |
| 43 | rainbow\r |
| 44 | \r |
| 45 | and see your stream.\r |
| 46 | \r |
| 47 | I shipped a feature which can display **tweet's images directly on terminal**.\r |
| 48 | You can try it with:\r |
| 49 | \r |
| 50 | .. code:: bash\r |
| 51 | \r |
| 52 | rainbow -iot # Or rainbow --image-on-term\r |
| 53 | \r |
| 54 | In the first time you will be asked for authorization of Rainbow Stream\r |
| 55 | app at Twitter. Just click the “Authorize access” button and paste PIN\r |
| 56 | number to the terminal, the rainbow will start.\r |
| 57 | \r |
| 58 | The interactive mode\r |
| 59 | ^^^^^^^^^^^^^^^^^^^^\r |
| 60 | \r |
| 61 | While your personal stream is continued, you are also ready to tweet,\r |
| 62 | search, reply, retweet… directly from console. Simply type “h” and hit\r |
| 63 | the Enter key to see the help.\r |
| 64 | \r |
| 65 | Input is in interactive mode. It means that you can use arrow key to\r |
| 66 | move up and down history, tab-autocomplete or 2 tab to view available\r |
| 67 | suggestion. Input history from previous run is available as well.\r |
| 68 | \r |
| 69 | Here is full list of supported command\r |
| 70 | \r |
| 71 | **Action Commands**\r |
| 72 | \r |
| 73 | - ``trend`` will show global trending topics. ``trend US`` will show\r |
| 74 | trends in United States while ``trend JP Tokyo`` will show trends\r |
| 75 | in Tokyo/Japan.\r |
| 76 | \r |
| 77 | - ``home`` will show your timeline. ``home 10`` will print exactly 10\r |
| 78 | tweets.\r |
| 79 | \r |
| 80 | - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r |
| 81 | exactly 9 tweets.\r |
| 82 | \r |
| 83 | - ``mentions`` will show mentions timeline. ``mentions 7`` will show\r |
| 84 | 7 mention tweets.\r |
| 85 | \r |
| 86 | - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r |
| 87 | rainbow is god’s promise to noah’*\r |
| 88 | \r |
| 89 | - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r |
| 90 | each tweet beside the time.\r |
| 91 | \r |
| 92 | - ``fav 12`` will favorite the tweet with *[id=12]*.\r |
| 93 | \r |
| 94 | - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r |
| 95 | \r |
| 96 | - ``del 12`` will delete tweet with *[id=12]*.\r |
| 97 | \r |
| 98 | - ``ufav 12`` will unfavorite tweet with *[id=12]*.\r |
| 99 | \r |
| 100 | - ``s #noah`` will search the word *‘noah’*. Result will come back\r |
| 101 | with highlight.\r |
| 102 | \r |
| 103 | - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r |
| 104 | \r |
| 105 | - ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r |
| 106 | \r |
| 107 | - ``ls fl`` will list all your followers (people who are following you).\r |
| 108 | \r |
| 109 | - ``ls fr`` will list all your friends (people who you are following).\r |
| 110 | \r |
| 111 | - ``inbox`` will show inbox messages. ``inbox 7`` will show newest\r |
| 112 | 7 message.\r |
| 113 | \r |
| 114 | - ``sent`` will show sent messages. ``sent 7`` will show newest\r |
| 115 | 7 message.\r |
| 116 | \r |
| 117 | - ``trash 5`` will remove message with *[message_id=5]*.\r |
| 118 | \r |
| 119 | - ``whois @dtvd88`` will show profile of @dtvd88.\r |
| 120 | \r |
| 121 | - ``fl @dtvd88`` will follow @dtvd88.\r |
| 122 | \r |
| 123 | - ``ufl @dtvd88`` will unfollow @dtvd88.\r |
| 124 | \r |
| 125 | - ``h`` will show the help.\r |
| 126 | \r |
| 127 | - ``c`` will clear the screen.\r |
| 128 | \r |
| 129 | - ``q`` will quit.\r |
| 130 | \r |
| 131 | **Stream Commands**\r |
| 132 | \r |
| 133 | - ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r |
| 134 | \r |
| 135 | - ``switch public #AKB48 -f`` will do exactly as above but will ask you\r |
| 136 | to provide 2 list:\r |
| 137 | \r |
| 138 | ``Only nicks`` decide what nicks will be include only.\r |
| 139 | \r |
| 140 | ``Ignore nicks`` decide what nicks will be exclude.\r |
| 141 | \r |
| 142 | - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r |
| 143 | *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r |
| 144 | \r |
| 145 | - ``switch mine`` will switch current stream to personal stream. ``-f``\r |
| 146 | and ``-d`` will work as well.\r |
| 147 | \r |
| 148 | \r |
| 149 | For example see the screenshot above.\r |
| 150 | \r |
| 151 | Bug Report\r |
| 152 | ----------\r |
| 153 | \r |
| 154 | Please `create an issue`_ or contact me at `@dtvd88`_\r |
| 155 | \r |
| 156 | License\r |
| 157 | -------\r |
| 158 | \r |
| 159 | Rainbow Stream are released under an MIT License. See LICENSE.txt for\r |
| 160 | details\r |
| 161 | \r |
| 162 | \r |
| 163 | .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r |
| 164 | .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r |
| 165 | .. _EarthQuake: https://github.com/jugyo/earthquake\r |
| 166 | .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r |
| 167 | .. _@dtvd88: https://twitter.com/dtvd88\r |