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     rainbow
  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     rainbow -iot # Or rainbow --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 -  ``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.
 100
 101 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
 102
 103 -  ``fav 12`` will favorite the tweet with *[id=12]*.
 104
 105 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
 106
 107 -  ``del 12`` will delete tweet with *[id=12]*.
 108
 109 -  ``show image 12`` will show the image in tweet with *[id=12]* in your
 110    OS’s image viewer.
 111
 112 **Direct Messages Commands**
 113
 114 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
 115    messages.
 116
 117 -  ``sent`` will show sent messages. ``sent 7`` will show newest 7
 118    messages.
 119
 120 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
 121
 122 -  ``trash 5`` will remove message with *[message\_id=5]*
 123
 124 **Friends and followers Commands**
 125
 126 -  ``ls fl`` will list all your followers (people who are following
 127    you).
 128
 129 -  ``ls fr`` will list all your friends (people who you are following).
 130
 131 -  ``fl @dtvd88`` will follow @dtvd88.
 132
 133 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 134
 135 -  ``mute @dtvd88`` will mute @dtvd88.
 136
 137 -  ``unmute @dtvd88`` will unmute @dtvd88.
 138
 139 -  ``muting`` will list muting users.
 140
 141 -  ``block @dtvd88`` will block @dtvd88.
 142
 143 -  ``unblock @dtvd88`` will unblock @dtvd88.
 144
 145 -  ``report @dtvd88`` will report @dtvd88 as a spam account.
 146
 147 **Switching Stream Commands**
 148
 149 -  ``switch public #AKB48`` will switch current stream to public stream
 150    and track keyword ``AKB48``
 151
 152 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you
 153    to provide 2 list:
 154
 155    ``Only nicks`` decide what nicks will be include only.
 156
 157    ``Ignore nicks``\ decide what nicks will be exclude.
 158
 159 -  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
 160    *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
 161
 162 -  ``switch mine`` will switch current stream to personal stream. ``-f``
 163    and ``-d`` will work as well.
 164
 165 **Smart shell**
 166
 167 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
 168
 169   + ``142857*2`` or ``101**3`` like a calculator.
 170   + Even ``cal`` will show the calendar for current month.
 171   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
 172
 173 **Screening Commands**
 174
 175 -  ``theme`` will list available themes.
 176
 177   + ``theme monokai`` will apply *monokai* theme immedaitely.
 178   + ``theme current_as_default`` will remember current theme as next time default.
 179
 180 -  ``h`` will show the help.
 181
 182 -  ``c`` will clear the screen.
 183
 184 -  ``q`` will quit.
 185
 186 Available commands are listed in `Read The Docs`_.
 187
 188 Theme customization
 189 ^^^^^^^^^^^^^^^^^^^
 190
 191 Rainbow Stream is shipped with some default themes.
 192 You can either change theme by ``theme`` command or create your favorite one.
 193
 194 Theme’s screenshot:
 195
 196 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
 197    :alt: monokai
 198
 199 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
 200    :alt: solarized
 201
 202 For detaile information, see `theme usage and customization`_.
 203
 204
 205 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 206 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 207 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md