README.rst

   1 Rainbow Stream
   2 --------------
   3
   4 |Download| |Version|
   5
   6 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
   7 favorite … and much more fun directly from terminal.
   8
   9 This package is built on top of `Python Twitter Tool`_ and `Twitter API`_.
  10
  11 Screenshot
  12 ----------
  13
  14 |rainbowstream| |rainbowstreamIOT|
  15
  16 Install
  17 -------
  18
  19 You will need Python 2.7+ and pip.
  20
  21 .. code:: bash
  22
  23     pip install rainbowstream
  24
  25 Usage
  26 -----
  27
  28 The stream
  29 ^^^^^^^^^^
  30
  31 Just type
  32
  33 .. code:: bash
  34
  35     rainbow
  36
  37 and see your stream.
  38
  39 I shipped a feature which can display **tweet’s images directly on
  40 terminal**. You can try it with:
  41
  42 .. code:: bash
  43
  44     rainbow -iot # Or rainbow --image-on-term
  45
  46 In the first time you will be asked for authorization of Rainbow Stream
  47 app at Twitter. Just click the “Authorize access” button and paste PIN
  48 number to the terminal, the rainbow will start
  49
  50
  51 The interactive mode
  52 ^^^^^^^^^^^^^^^^^^^^
  53
  54 While your personal stream is continued, you are also ready to tweet,
  55 search, reply, retweet… directly from console. Simply type “h” and hit
  56 the Enter key to see the help.
  57
  58 Input is in interactive mode. It means that you can use arrow key to
  59 move up and down history, tab-autocomplete or 2 tab to view available
  60 suggestion. Input history from previous run is available as well.
  61
  62 Here is full list of supported command
  63
  64 **Action Commands**
  65
  66 -  ``trend`` will show global trending topics. ``trend US`` will show
  67    trends in United States while ``trend JP Tokyo`` will show trends in
  68    Tokyo/Japan.
  69
  70 -  ``home`` will show your timeline. ``home 10`` will print exactly 10
  71    tweets.
  72
  73 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
  74    exactly 9 tweets.
  75
  76 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
  77    mention tweets.
  78
  79 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
  80    rainbow is god’s promise to noah’*.
  81
  82 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
  83    each tweet beside the time.
  84
  85 -  ``fav 12`` will favorite the tweet with *[id=12]*.
  86
  87 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
  88
  89 -  ``del 12`` will delete tweet with *[id=12]*.
  90
  91 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
  92
  93 -  ``s #noah`` will search the word *‘noah’*. Result will come back with
  94    highlight.
  95
  96 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
  97
  98 -  ``show image 12`` will show the image in tweet with *[id=12]* in your
  99    OS’s image viewer.
 100
 101 -  ``ls fl`` will list all your followers (people who are following
 102    you).
 103
 104 -  ``ls fr`` will list all your friends (people who you are following).
 105
 106 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
 107    messages.
 108
 109 -  ``sent`` will show sent messages. ``sent 7`` will show newest 7
 110    messages.
 111
 112 -  ``trash 5`` will remove message with *[message\_id=5]*
 113
 114 -  ``whois @dtvd88`` will show profile of @dtvd88.
 115
 116 -  ``fl @dtvd88`` will follow @dtvd88.
 117
 118 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 119
 120 -  ``h`` will show the help.
 121
 122 -  ``c`` will clear the screen.
 123
 124 -  ``q`` will quit.
 125
 126 **Stream Commands**
 127
 128 -  ``switch public #AKB48`` will switch current stream to public stream
 129    and track keyword ``AKB48``
 130
 131 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you
 132    to provide 2 list:
 133
 134    ``Only nicks`` decide what nicks will be include only.
 135
 136    ``Ignore nicks``\ decide what nicks will be exclude.
 137
 138 -  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
 139    *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
 140
 141 -  ``switch mine`` will switch current stream to personal stream. ``-f``
 142    and ``-d`` will work as well.
 143
 144 For example see the screenshot above.
 145
 146 Bug Report
 147 ----------
 148
 149 Please `create an issue`_ or contact me at
 150 [@dtvd88](https://twitter.com/dtvd88)
 151
 152 License
 153 -------
 154
 155 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 156 details
 157
 158
 159 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 160 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 161 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 162
 163 .. |Download| image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat
 164    :target: https://pypi.python.org/pypi/rainbowstream
 165 .. |Version| image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat
 166    :target: https://pypi.python.org/pypi/rainbowstream
 167 .. |rainbowstream| image:: ./screenshot/RainbowStream.png
 168 .. |rainbowstreamIOT| image:: ./screenshot/RainbowStreamIOT.png