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 Showcase
  16 ----------
  17 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
  18
  19 Screenshot:
  20
  21 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png
  22    :alt: rainbowstream
  23
  24 Install
  25 -------
  26
  27 You will need Python 2.7+ and pip.
  28
  29 .. code:: bash
  30
  31     sudo pip install rainbowstream
  32
  33 or try with a virtualenv
  34
  35 .. code:: bash
  36
  37     sudo pip install virtualenv # skip if you already have virtualenv
  38     virtualenv venv
  39     source venv/bin/activate # use the brand new virtualenv.
  40     pip install rainbowstream
  41
  42 Usage
  43 -----
  44
  45 The stream
  46 ^^^^^^^^^^
  47
  48 Just type
  49
  50 .. code:: bash
  51
  52     rainbowstream
  53
  54 and see your stream.
  55
  56 I shipped a feature which can display **tweet's images directly on terminal**.
  57 You can try it with:
  58
  59 .. code:: bash
  60
  61     rainbowstream -iot # Or rainbowstream --image-on-term
  62
  63 In the first time you will be asked for authorization of Rainbow Stream
  64 app at Twitter. Just click the “Authorize access” button and paste PIN
  65 number to the terminal, the rainbow will start.
  66
  67 The interactive mode
  68 --------------------
  69
  70 While your personal stream is continued, you are also ready to tweet,
  71 search, reply, retweet… directly from console. Simply type “h” and hit
  72 the Enter key to see the help.
  73
  74 Input is in interactive mode. It means that you can use arrow key to
  75 move up and down history, tab-autocomplete or 2 tab to view available
  76 suggestion. Input history from previous run is available as well.
  77
  78 Available commands are listed in `Read The Docs`_.
  79
  80 Theme customization
  81 ------------------------
  82
  83 Rainbow Stream is shipped with some default themes.
  84 You can either change theme by ``theme`` command or create your favorite one.
  85
  86 Theme’s screenshot:
  87
  88 - Monokai
  89
  90 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
  91    :alt: monokai
  92
  93 - Solarized
  94
  95 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
  96    :alt: solarized
  97
  98 - Tomorrow Night
  99
 100 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
 101    :alt: tomorrownight
 102
 103 - Larapaste
 104
 105 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
 106    :alt: larapaste
 107
 108
 109 For detaile information, see `theme usage and customization`_.
 110
 111 Bug and feature requests
 112 ------------------------
 113
 114 Found a bug or a feature request ?
 115 Please `create an issue`_ or contact me at `@dtvd88`_
 116
 117 Contributing
 118 ------------
 119 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
 120 You will be listed as contributor.
 121
 122 License
 123 -------
 124
 125 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 126 details
 127
 128
 129 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 130 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 131 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 132 .. _@dtvd88: https://twitter.com/dtvd88
 133 .. _fork: https://github.com/DTVD/rainbowstream/fork
 134 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
 135 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
 136 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 137 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md