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