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