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 can run on Python 2.7.x and 3.x .
  15
  16
  17 Showcase
  18 ----------
  19 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
  20
  21 Screenshot: (click to see)
  22
  23 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png
  24    :alt: all
  25
  26 Install
  27 -------
  28
  29 The quick way
  30 ^^^^^^^^^^^^^
  31
  32 You will need Python and pip (2.7.x or 3.x).
  33
  34 .. code:: bash
  35
  36     sudo pip install rainbowstream
  37     # Python 3 users: sudo pip3 install rainbowstream
  38
  39
  40 The recommended way
  41 ^^^^^^^^^^^^^^^^^^^
  42
  43 Use `virtualenv`_
  44
  45 .. code:: bash
  46
  47     virtualenv venv
  48     # Python 3 users : use -p to specify your Python 3 localtion as below
  49     # virtualenv -p /usr/bin/python3 venv
  50     source venv/bin/activate
  51     pip install rainbowstream
  52
  53
  54 Usage
  55 -----
  56
  57 The stream
  58 ^^^^^^^^^^
  59
  60 Just type
  61
  62 .. code:: bash
  63
  64     rainbowstream
  65
  66 and see your stream.
  67
  68 I shipped a feature which can display **tweet's images directly on terminal**.
  69 You can try it with:
  70
  71 .. code:: bash
  72
  73     rainbowstream -iot # Or rainbowstream --image-on-term
  74
  75 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
  76 to enable above feature (see `config management`_ section).
  77
  78 In the first time you will be asked for authorization of Rainbow Stream
  79 app at Twitter. Just click the “Authorize access” button and paste PIN
  80 number to the terminal, the rainbow will start.
  81
  82 The interactive mode
  83 --------------------
  84
  85 While your personal stream is continued, you are also ready to tweet,
  86 search, reply, retweet… directly from console. Simply type “h” and hit
  87 the Enter key to see the help.
  88
  89 Input is in interactive mode. It means that you can use arrow key to
  90 move up and down history, tab-autocomplete or 2 tab to view available
  91 suggestion. Input history from previous run is available as well.
  92
  93 Available commands are listed in `Read The Docs`_.
  94
  95 Theme customization
  96 ------------------------
  97
  98 Rainbow Stream is shipped with some default themes.
  99 You can either change theme by ``theme`` command or create your favorite one.
 100
 101 Theme’s screenshot:
 102
 103 - Monokai
 104
 105 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
 106    :alt: monokai
 107
 108 - Solarized
 109
 110 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
 111    :alt: solarized
 112
 113 - Tomorrow Night
 114
 115 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
 116    :alt: tomorrownight
 117
 118 - Larapaste
 119
 120 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
 121    :alt: larapaste
 122
 123
 124 For detaile information, see `theme usage and customization`_.
 125
 126 Bug and feature requests
 127 ------------------------
 128
 129 Found a bug or a feature request ?
 130 Please `create an issue`_ or contact me at `@dtvd88`_
 131
 132 Development
 133 -----------
 134
 135 If you want to build a runnable version yourself, follow these simple
 136 steps
 137
 138 -  `Create your own Twitter Application`_
 139 -  Get your Twitter application’s API key and secret
 140 -  Fork this repo and clone in your system.
 141 -  Create a file ``consumer.py`` in `rainbowstream`_ folder with
 142    following content
 143
 144    .. code:: python
 145
 146        # Consumer information
 147        CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
 148        CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
 149
 150 -  Use pip to install in local
 151
 152    .. code:: bash
 153
 154        # cd to directory which contains setup.py (cloned directory)
 155        virtualenv venv # Python3 users: use -p to specify python3
 156        source venv/bin/activate
 157        pip install -e .
 158        which rainbowstream # /this-directory/venv/bin/rainbowstream
 159        pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
 160        # Remove ~/.rainbow_oauth if exists
 161        rainbowstream # local version of rainbowstream
 162
 163
 164 Contributing
 165 ------------
 166 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
 167 You will be listed as contributor.
 168
 169 License
 170 -------
 171
 172 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 173 details
 174
 175
 176 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 177 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 178 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 179 .. _@dtvd88: https://twitter.com/dtvd88
 180 .. _fork: https://github.com/DTVD/rainbowstream/fork
 181 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
 182 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
 183 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 184 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 185 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
 186 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
 187 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
 188 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode