Skip to content

Latest commit

 

History

History
111 lines (87 loc) · 3.72 KB

README.md

File metadata and controls

111 lines (87 loc) · 3.72 KB
Raw

Rainbow Stream

Download Version

Terminal-based Twitter Client. Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.

This package is built on top of Python Twitter Tool and Twitter API.

Showcase

Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s

Screenshot: (Click to see) rainbowstream

Install

You will need Python 2.7+ and pip.

sudo pip install rainbowstream

or try with a virtualenv

sudo pip install virtualenv # skip if you already have virtualenv
virtualenv venv
source venv/bin/activate # use the brand new virtualenv.
pip install rainbowstream

Usage

The stream

Just type

rainbowstream

and see your stream.

I shipped a feature which can display tweet's images directly on terminal. You can try it with:

rainbowstream -iot # Or rainbowstream --image-on-term

In the first time you will be asked for authorization of Rainbow Stream app at Twitter. Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.

Interactive mode

While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console. Simply type "h" and hit the Enter key to see the help.

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.

Available commands

Available commands are listed in ReadTheDocs documents .

Theme customization

Rainbow Stream is shipped with some default themes. You can either change theme by theme command or create your favorite one.

Theme's screenshot:

  • Monokai Monokai
  • Solarized Solarized
  • Tomorrow Night Solarized
  • Larapaste Solarized

For detaile information, see theme usage and customization

Bug and feature requests

Found a bug or a feature request ? Please create an issue or contact me at @dtvd88

Development

If you want to build a runnable version yourself, follow these simple steps

# Consumer information
CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
  • Use pip to install in local
# cd to directory which contains setup.py
pip install -e .
pip list | grep rainbowstream # confirm installed version
rainbowstream # local version of rainbowstream

Contributing

I appreciate any help and support. Feel free to fork and create a pull request. You will be listed as contributor.

License

Rainbow Stream are released under an MIT License. See LICENSE.txt for details