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