docs/index.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 Install
  16 -------
  17
  18 The quick way
  19 ^^^^^^^^^^^^^
  20
  21 You will need Python 2.7 and pip.
  22
  23 .. code:: bash
  24
  25     sudo pip install rainbowstream
  26
  27 The recommended way
  28 ^^^^^^^^^^^^^^^^^^^
  29
  30 Use `virtualenv`_
  31
  32 .. code:: bash
  33
  34     virtualenv venv
  35     # Python 3 users : use -p to specify your Python 3 localtion as below
  36     # virtualenv -p /usr/bin/python3 venv
  37     source venv/bin/activate
  38     pip install rainbowstream
  39
  40
  41 Usage
  42 -----
  43
  44 The stream
  45 ^^^^^^^^^^
  46
  47 Just type
  48
  49 .. code:: bash
  50
  51     rainbowstream
  52
  53 and see your stream.
  54
  55 I shipped a feature which can display **tweet's images directly on terminal**.
  56 You can try it with:
  57
  58 .. code:: bash
  59
  60     rainbowstream -iot # Or rainbowstream --image-on-term
  61
  62 In the first time you will be asked for authorization of Rainbow Stream
  63 app at Twitter. Just click the “Authorize access” button and paste PIN
  64 number to the terminal, the rainbow will start.
  65
  66 The interactive mode
  67 ^^^^^^^^^^^^^^^^^^^^
  68
  69 While your personal stream is continued, you are also ready to tweet,
  70 search, reply, retweet… directly from console. Simply type “h” and hit
  71 the Enter key to see the help.
  72
  73 Input is in interactive mode. It means that you can use arrow key to
  74 move up and down history, tab-autocomplete or 2 tab to view available
  75 suggestion. Input history from previous run is available as well.
  76
  77 Here is full list of supported command:
  78
  79 **Explore Commands**
  80
  81 -  ``trend`` will show global trending topics. ``trend US`` will show
  82    trends in United States while ``trend JP Tokyo`` will show trends in
  83    Tokyo/Japan.
  84
  85 -  ``home`` will show your timeline. ``home 10`` will print exactly 10
  86    tweets.
  87
  88 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
  89    mention tweets.
  90
  91 -  ``whois @dtvd88`` will show profile of @dtvd88.
  92
  93 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
  94    exactly 9 tweets.
  95
  96 -  ``s #noah`` will search the word *‘noah’*. Result will come back with
  97    highlight.
  98
  99 **Tweet Commands**
 100
 101 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
 102    rainbow is god’s promise to noah’*.
 103
 104 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
 105    each tweet beside the time.
 106
 107 -  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
 108    the quote will be cancelled.
 109
 110 -  ``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.
 111
 112 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
 113
 114 -  ``fav 12`` will favorite the tweet with *[id=12]*.
 115
 116 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
 117
 118 -  ``del 12`` will delete tweet with *[id=12]*.
 119
 120 -  ``show image 12`` will show the image in tweet with *[id=12]* in your
 121    OS’s image viewer.
 122
 123 -  ``open 12`` will open url in tweet with *[id=12]* in your
 124    OS’s default browser.
 125
 126 **Direct Messages Commands**
 127
 128 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
 129    messages.
 130
 131 -  ``sent`` will show sent messages. ``sent 7`` will show newest 7
 132    messages.
 133
 134 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
 135
 136 -  ``trash 5`` will remove message with *[message\_id=5]*
 137
 138 **Friends and followers Commands**
 139
 140 -  ``ls fl`` will list all your followers (people who are following
 141    you).
 142
 143 -  ``ls fr`` will list all your friends (people who you are following).
 144
 145 -  ``fl @dtvd88`` will follow @dtvd88.
 146
 147 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 148
 149 -  ``mute @dtvd88`` will mute @dtvd88.
 150
 151 -  ``unmute @dtvd88`` will unmute @dtvd88.
 152
 153 -  ``muting`` will list muting users.
 154
 155 -  ``block @dtvd88`` will block @dtvd88.
 156
 157 -  ``unblock @dtvd88`` will unblock @dtvd88.
 158
 159 -  ``report @dtvd88`` will report @dtvd88 as a spam account.
 160
 161 **Switching Stream Commands**
 162
 163 -  ``switch public #AKB48`` will switch current stream to public stream
 164    and track keyword ``AKB48``
 165
 166 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you
 167    to provide 2 list:
 168
 169    ``Only nicks`` decide what nicks will be include only.
 170
 171    ``Ignore nicks``\ decide what nicks will be exclude.
 172
 173 -  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
 174    *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
 175
 176 -  ``switch mine`` will switch current stream to personal stream. ``-f``
 177    and ``-d`` will work as well.
 178
 179 **Smart shell**
 180
 181 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
 182
 183   + ``142857*2`` or ``101**3`` like a calculator.
 184   + Even ``cal`` will show the calendar for current month.
 185   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
 186
 187 **Screening Commands**
 188
 189 -  ``theme`` will list available themes.
 190
 191   + ``theme monokai`` will apply *monokai* theme immedaitely.
 192   + ``theme current_as_default`` will remember current theme as next time default.
 193
 194 -  ``h`` will show the help.
 195
 196 -  ``c`` will clear the screen.
 197
 198 -  ``q`` will quit.
 199
 200 Available commands are listed in `Read The Docs`_.
 201
 202 Theme customization
 203 ^^^^^^^^^^^^^^^^^^^
 204
 205 Rainbow Stream is shipped with some default themes.
 206 You can either change theme by ``theme`` command or create your favorite one.
 207
 208 Theme’s screenshot:
 209
 210 - Monokai
 211
 212 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
 213    :alt: monokai
 214
 215 - Solarized
 216
 217 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
 218    :alt: solarized
 219
 220 - Tomorrow Night
 221
 222 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
 223    :alt: tomorrownight
 224
 225 - Larapaste
 226
 227 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
 228    :alt: larapaste
 229
 230 For detaile information, see `theme usage and customization`_.
 231
 232
 233 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 234 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 235 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 236 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/