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