README.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 Screenshot
  16 ----------
  17
  18 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
  19    :alt: rainbowstream
  20
  21 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
  22    :alt: rainbowstreamIOT
  23
  24 Install
  25 -------
  26
  27 You will need Python 2.7+ and pip.
  28
  29 .. code:: bash
  30
  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 **Action 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
  75    in Tokyo/Japan.
  76
  77 -  ``home`` will show your timeline. ``home 10`` will print exactly 10
  78    tweets.
  79
  80 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
  81    exactly 9 tweets.
  82
  83 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show
  84    7 mention tweets.
  85
  86 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
  87    rainbow is god’s promise to noah’*
  88
  89 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
  90    each tweet beside the time.
  91
  92 -  ``fav 12`` will favorite the tweet with *[id=12]*.
  93
  94 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
  95
  96 -  ``del 12`` will delete tweet with *[id=12]*.
  97
  98 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
  99
 100 -  ``s #noah`` will search the word *‘noah’*. Result will come back
 101    with highlight.
 102
 103 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
 104
 105 -  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.
 106
 107 -  ``ls fl`` will list all your followers (people who are following you).
 108
 109 -  ``ls fr`` will list all your friends (people who you are following).
 110
 111 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest
 112    7 message.
 113
 114 -  ``sent`` will show sent messages. ``sent 7`` will show newest
 115    7 message.
 116
 117 -  ``trash 5`` will remove message with *[message_id=5]*.
 118
 119 -  ``whois @dtvd88`` will show profile of @dtvd88.
 120
 121 -  ``fl @dtvd88`` will follow @dtvd88.
 122
 123 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 124
 125 -  ``h`` will show the help.
 126
 127 -  ``c`` will clear the screen.
 128
 129 -  ``q`` will quit.
 130
 131 **Stream Commands**
 132
 133 -  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``
 134
 135 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you
 136    to provide 2 list:
 137
 138    ``Only nicks`` decide what nicks will be include only.
 139
 140    ``Ignore nicks`` decide what nicks will be exclude.
 141
 142 -  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
 143    *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
 144
 145 -  ``switch mine`` will switch current stream to personal stream. ``-f``
 146    and ``-d`` will work as well.
 147
 148
 149 For example see the screenshot above.
 150
 151 Bug Report
 152 ----------
 153
 154 Please `create an issue`_ or contact me at `@dtvd88`_
 155
 156 License
 157 -------
 158
 159 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 160 details
 161
 162
 163 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 164 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 165 .. _EarthQuake: https://github.com/jugyo/earthquake
 166 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 167 .. _@dtvd88: https://twitter.com/dtvd88