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