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