README.md

   1 ## Rainbow Stream
   2
   3 [![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
   4 [![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
   5
   6 Terminal-based Twitter Client.
   7 Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
   8
   9 This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
  10
  11 ## Showcase
  12 Screencast:
  13 https://www.youtube.com/watch?v=tykCvPMJq8s
  14 <br>
  15
  16 Screenshot: (Click to see)
  17 ![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png)
  18
  19 ## Install
  20 You will need Python 2.7+ and pip.
  21
  22 ```bash
  23 sudo pip install rainbowstream
  24 ```
  25
  26 or try with a virtualenv
  27 ```bash
  28 sudo pip install virtualenv # skip if you already have virtualenv
  29 virtualenv venv
  30 source venv/bin/activate # use the brand new virtualenv.
  31 pip install rainbowstream
  32 ```
  33
  34
  35 ## Usage
  36 #### The stream
  37 Just type
  38 ```bash
  39 rainbowstream
  40 ```
  41 and see your stream.
  42
  43 I shipped a feature which can display **tweet's images directly on terminal**.
  44 You can try it with:
  45 ```bash
  46 rainbowstream -iot # Or rainbowstream --image-on-term
  47 ```
  48
  49 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
  50 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
  51
  52 ## Interactive mode
  53
  54 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
  55 Simply type "h" and hit the Enter key to see the help.
  56
  57 Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well.
  58
  59 Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) .
  60
  61 ## Theme customization
  62 Rainbow Stream is shipped with some default themes.
  63 You can either change theme by `theme` command or create your favorite one.
  64
  65 Theme's screenshot:
  66 * Monokai
  67 ![Monokai](./screenshot/themes/Monokai.png)
  68 * Solarized
  69 ![Solarized](./screenshot/themes/Solarized.png)
  70 * Tomorrow Night
  71 ![Solarized](./screenshot/themes/TomorrowNight.png)
  72 * Larapaste
  73 ![Solarized](./screenshot/themes/larapaste.png)
  74
  75 For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
  76
  77 ## Bug and feature requests
  78 Found a bug or a feature request ?
  79 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
  80 or contact me at [@dtvd88](https://twitter.com/dtvd88)
  81
  82 ## Development
  83 If you want to build a runnable version yourself, follow these simple steps
  84 * [Create your own Twitter Application](https://apps.twitter.com/app/new)
  85 * Get your Twitter application's API key and secret
  86 * Fork this repo
  87 * Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content
  88 ```python
  89 # Consumer information
  90 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
  91 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
  92 ```
  93 * Use pip to install in local
  94 ```bash
  95 # cd to directory which contains setup.py
  96 pip install -e .
  97 pip list | grep rainbowstream # confirm installed version
  98 rainbowstream # local version of rainbowstream
  99 ```
 100
 101 ## Contributing
 102 I appreciate any help and support. Feel free to
 103 [fork](https://github.com/DTVD/rainbowstream/fork)
 104 and
 105 [create a pull request](https://github.com/DTVD/rainbowstream/compare/).
 106 You will be listed as contributor.
 107
 108 ## License
 109 Rainbow Stream are released under an MIT License. See LICENSE.txt for details