README.rst

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