README.rst

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