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