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 can run on Python 2.7.x and 3.x .
  15
  16 Install
  17 -------
  18
  19 The quick way
  20 ^^^^^^^^^^^^^
  21
  22 You will need Python and pip (2.7.x or 3.x).
  23
  24 .. code:: bash
  25
  26     sudo pip install rainbowstream
  27     # Python 3 users: sudo pip3 install rainbowstream
  28
  29 The recommended way
  30 ^^^^^^^^^^^^^^^^^^^
  31
  32 Use `virtualenv`_
  33
  34 .. code:: bash
  35
  36     virtualenv venv
  37     # Python 3 users : use -p to specify your Python 3 localtion as below
  38     # virtualenv -p /usr/bin/python3 venv
  39     source venv/bin/activate
  40     pip install rainbowstream
  41
  42 Troubleshooting
  43 ^^^^^^^^^^^^^^^
  44
  45 Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with
  46 the ``Pillow`` package installation - a dependency of this app.
  47 If you are in this case, I recommend take a look at `Issue #10`_ and let me know if the workaround doesn't work for you.
  48
  49 Usage
  50 -----
  51
  52 The stream
  53 ^^^^^^^^^^
  54
  55 Just type
  56
  57 .. code:: bash
  58
  59     rainbowstream
  60
  61 and see your stream.
  62
  63 I shipped a feature which can display **tweet's images directly on terminal**.
  64 You can try it with:
  65
  66 .. code:: bash
  67
  68     rainbowstream -iot # Or rainbowstream --image-on-term
  69
  70 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
  71 to enable above feature (see `config management`_ section).
  72
  73 In the first time you will be asked for authorization of Rainbow Stream
  74 app at Twitter. Just click the “Authorize access” button and paste PIN
  75 number to the terminal, the rainbow will start.
  76
  77 The interactive mode
  78 ^^^^^^^^^^^^^^^^^^^^
  79
  80 While your personal stream is continued, you are also ready to tweet,
  81 search, reply, retweet… directly from console. Simply type “h” and hit
  82 the Enter key to see the help.
  83
  84 Input is in interactive mode. It means that you can use arrow key to
  85 move up and down history, tab-autocomplete or 2 tab to view available
  86 suggestion. Input history from previous run is available as well.
  87
  88 Here is full list of supported command:
  89
  90 **Explore Commands**
  91
  92 -  ``trend`` will show global trending topics. ``trend US`` will show
  93    trends in United States while ``trend JP Tokyo`` will show trends in
  94    Tokyo/Japan.
  95
  96 -  ``home`` will show your timeline. ``home 10`` will print exactly 10
  97    tweets.
  98
  99 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
 100    mention tweets.
 101
 102 -  ``whois @dtvd88`` will show profile of @dtvd88.
 103
 104 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
 105    exactly 9 tweets.
 106
 107 -  ``s noah`` will search the word *‘noah’*. Result will come back with
 108    highlight. Search can be performed with or without hashtag.
 109
 110 **Tweet Commands**
 111
 112 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
 113    rainbow is god’s promise to noah’*.
 114
 115 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
 116    each tweet beside the time.
 117
 118 -  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
 119    the quote will be cancelled.
 120
 121 -  ``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.
 122
 123 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
 124
 125 -  ``fav 12`` will favorite the tweet with *[id=12]*.
 126
 127 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
 128
 129 -  ``del 12`` will delete tweet with *[id=12]*.
 130
 131 -  ``show image 12`` will show the image in tweet with *[id=12]* in your
 132    OS’s image viewer.
 133
 134 -  ``open 12`` will open url in tweet with *[id=12]* in your
 135    OS’s default browser.
 136
 137 **Direct Messages Commands**
 138
 139 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
 140    messages.
 141
 142 -  ``sent`` will show sent messages. ``sent 7`` will show newest 7
 143    messages.
 144
 145 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
 146
 147 -  ``trash 5`` will remove message with *[message\_id=5]*
 148
 149 **Friends and followers Commands**
 150
 151 -  ``ls fl`` will list all your followers (people who are following
 152    you).
 153
 154 -  ``ls fr`` will list all your friends (people who you are following).
 155
 156 -  ``fl @dtvd88`` will follow @dtvd88.
 157
 158 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 159
 160 -  ``mute @dtvd88`` will mute @dtvd88.
 161
 162 -  ``unmute @dtvd88`` will unmute @dtvd88.
 163
 164 -  ``muting`` will list muting users.
 165
 166 -  ``block @dtvd88`` will block @dtvd88.
 167
 168 -  ``unblock @dtvd88`` will unblock @dtvd88.
 169
 170 -  ``report @dtvd88`` will report @dtvd88 as a spam account.
 171
 172 **Twitter list**
 173
 174 -  ``list`` will show all lists you are belong to.
 175
 176 -  ``list home`` will show timeline of list. You will be asked for list's name.
 177
 178 -  ``list all_mem`` will show list's all members.
 179
 180 -  ``list all_sub`` will show list's all subscribers.
 181
 182 -  ``list add`` will add specific person to a list owned by you.
 183
 184 -  ``list rm`` will remove specific person from a list owned by you.
 185
 186 -  ``list sub`` will subscribe you to a specific list.
 187
 188 -  ``list unsub`` will unsubscribe you from a specific list.
 189
 190 -  ``list own`` will show all list owned by you.
 191
 192 -  ``list new`` will create a new list.
 193
 194 -  ``list update`` will update a list owned by you.
 195
 196 -  ``list del`` will delete a list owned by you.
 197
 198 **Switching Stream Commands**
 199
 200 -  ``switch public #AKB48`` will switch current stream to public stream
 201    and track keyword ``AKB48``
 202
 203 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you
 204    to provide 2 list:
 205
 206    ``Only nicks`` decide what nicks will be include only.
 207
 208    ``Ignore nicks``\ decide what nicks will be exclude.
 209
 210 -  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
 211    *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
 212
 213 -  ``switch mine`` will switch current stream to personal stream. ``-f``
 214    and ``-d`` will work as well.
 215
 216 **Smart shell**
 217
 218 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
 219
 220   + ``142857*2`` or ``101**3`` like a calculator.
 221   + Even ``cal`` will show the calendar for current month.
 222   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
 223
 224 **Config Management**
 225
 226 -  ``theme`` will list available themes.
 227
 228   + ``theme monokai`` will apply *monokai* theme immediately.
 229   + Changed theme will be remember as the next time's default theme.
 230
 231 -  ``config`` will list all config key.
 232
 233   + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.
 234   + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.
 235   + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.
 236   + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.
 237
 238 **Screening Commands**
 239
 240 -  ``h`` will show the help.
 241
 242 -  ``p`` will pause the stream.
 243
 244 -  ``r`` will unpause the stream.
 245
 246 -  ``c`` will clear the screen.
 247
 248 -  ``q`` will quit.
 249
 250 Available commands are listed in `Read The Docs`_.
 251
 252 Theme customization
 253 ^^^^^^^^^^^^^^^^^^^
 254
 255 Rainbow Stream is shipped with some default themes.
 256 You can either change theme by ``theme`` command or create your favorite one.
 257
 258 Theme’s screenshot:
 259
 260 - Monokai
 261
 262 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
 263    :alt: monokai
 264
 265 - Solarized
 266
 267 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
 268    :alt: solarized
 269
 270 - Tomorrow Night
 271
 272 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
 273    :alt: tomorrownight
 274
 275 - Larapaste
 276
 277 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
 278    :alt: larapaste
 279
 280 For detaile information, see `theme usage and customization`_.
 281
 282 Config explanation
 283 ^^^^^^^^^^^^^^^^^^
 284
 285 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.
 286 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
 287
 288 -  ``THEME``: current theme.
 289
 290 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
 291
 292 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
 293
 294 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
 295
 296 -  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
 297
 298 -  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
 299
 300 -  ``TREND_MAX``: default trends to display on 'trend' command.
 301
 302 -  ``LIST_MAX``: default tweets to display on 'list home' command.
 303
 304 -  ``ONLY_LIST``: filter list on 'switch' command.
 305
 306 -  ``IGNORE_LIST``: ignore list on 'switch' command.
 307
 308 -  ``HISTORY_FILENAME``: name of file which stores input history.
 309
 310 -  ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.
 311
 312 -  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.
 313
 314 -  ``USER_DOMAIN``: user URL of Twitter Streaming API.
 315
 316 -  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.
 317
 318 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.
 319
 320 -  ``FORMAT``: display format for tweet and message.
 321
 322   + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.
 323   + ``DISPLAY``: decide how tweet will be printed.
 324
 325     + ``#name``: Twitter's name
 326     + ``#nick``: Twitter's screen name
 327     + ``#clock``: Datetime
 328     + ``#id``: ID
 329     + ``#fav``: favorited symbol
 330     + ``#tweet``: Tweet's content
 331     + ``#sender_name``: Message's sender name
 332     + ``#sender_nick``: Message's sender screen name
 333     + ``#to``: '>>>' symbol
 334     + ``#recipient_name``: Message's recipient name
 335     + ``#recipient_nick``: Message's recipient screen name
 336
 337
 338 Development
 339 -----------
 340
 341 If you want to build a runnable version yourself, follow these simple
 342 steps
 343
 344 -  `Create your own Twitter Application`_
 345 -  Get your Twitter application’s API key and secret
 346 -  Fork github's repo and clone in your system.
 347 -  Create a file ``consumer.py`` in ```rainbowstream```_ folder with
 348    following content
 349
 350    .. code:: python
 351
 352        # Consumer information
 353        CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
 354        CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
 355
 356 -  Use pip to install in local
 357
 358    .. code:: bash
 359
 360        # cd to directory which contains setup.py (cloned directory)
 361        virtualenv venv # Python3 users: use -p to specify python3
 362        source venv/bin/activate
 363        pip install -e .
 364        which rainbowstream # /this-directory/venv/bin/rainbowstream
 365        pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
 366        # Remove ~/.rainbow_oauth if exists
 367        rainbowstream # local version of rainbowstream
 368
 369 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
 370 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
 371 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 372 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 373 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 374 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
 375 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode
 376 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime
 377 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
 378 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10
 379