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