Terminal-based Twitter Client. Realtime tweetstream, compose, search , favorite … and much more fun directly from terminal.
You will need Python and pip (2.7.x or 3.x).
sudo pip install rainbowstream # Python 3 users: sudo pip3 install rainbowstream
virtualenv venv # Python 3 users : use -p to specify your Python 3 localtion as below # virtualenv -p /usr/bin/python3 venv source venv/bin/activate pip install rainbowstream
If you use Linux, you might need to install some packages if you haven’t already. For debian-based distros, these can be installed with
sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev
Besides, Mac OSX Maverick with Xcode 5.1 has a well-known clang unknown argument problem with the Pillow package installation - a dependency of this app. If you are in this case, I recommend taking a look at Issue #10 and let me know if this workaround doesn’t work for you.
If installation in the quick way doesn’t work:
- Your OS
- Your Python version
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
You also can change the config key IMAGE_ON_TERM to True inside the app to enable above feature, change IMAGE_SHIFT to set image’s margin (relative to your terminal’s width) or IMAGE_MAX_HEIGHT to control max height of every image. (see config management section).
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.
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.
Here is full list of supported command:
Direct Messages Commands
Friends and followers Commands
Switching Stream Commands
switch public #AKB48 will switch current stream to public stream and track keyword AKB48
switch public #AKB48 -f will do exactly as above but will ask you to provide 2 list:
Only nicks decide what nicks will be include only.
Ignore nicksdecide what nicks will be exclude.
switch public #AKB48 -d will apply filter to ONLY_LIST and IGNORE_LIST. You can setup 2 list above at config.py
switch mine will switch current stream to personal stream. -f and -d will work as well.
switch list will switch to a Twitter list’s stream. You will be asked for list name.
- theme monokai will apply monokai theme immediately.
- Changed theme will be remember as the next time’s default theme.
- config ASCII_ART will output current value of ASCII_ART config key.
- config TREND_MAX default will output default value of TREND_MAX config key.
- config CUSTOM_CONFIG drop will drop CUSTOM_CONFIG config key.
- config IMAGE_ON_TERM = true will set value of IMAGE_ON_TERM config key to True.
Rainbow Stream is shipped with some default themes. You can either change theme by theme command or create your favorite one.
For detaile information, see theme usage and customization.
Rainbow Stream has a custom config file located at ~/.rainbow_config.json which will be loaded after its default config. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the default config to solve format problems.
You also can view or set a new value of every config key by config command (See Interactive mode section above).
HEARTBEAT_TIMEOUT: after this timeout (count by minutes), the stream will automatically hangup.
IMAGE_ON_TERM: display tweet’s image directly on terminal.
THEME: current theme.
ASCII_ART: diplay your twitter name by ascii art at stream begin or not.
HIDE_PROMPT: hide prompt after receiving a tweet or not.
PREFIX: display string of prompt.
SEARCH_TYPE: search type in ‘search’ command (‘mixed’,’recent’,’popular’).
SEARCH_MAX_RECORD: max tweets can display on ‘search’ command.
HOME_TWEET_NUM: default tweets to display on ‘home’ command.
RETWEETS_SHOW_NUM: default tweets to display on ‘allrt’ command.
CONVERSATION_MAX: max tweet in a ‘conversation’ thread.
QUOTE_FORMAT: format when quote a tweet
- #comment: Your own comment about the tweet
- #owner: owner’s username with ‘@’
- #tweet: original tweet
THREAD_META_LEFT: format for meta information of messages from partner which is display in the left of screen.
THREAD_META_RIGHT: format for meta information of messages from you which is display in the right of screen.
THREAD_MIN_WIDTH: minimum width of a message frame.
NOTIFY_FORMAT: format of a notification.
MESSAGES_DISPLAY: default messages to display on ‘inbox’ or ‘sent’ command.
TREND_MAX: default trends to display on ‘trend’ command.
LIST_MAX: default tweets to display on ‘list home’ command.
ONLY_LIST: filter list on ‘switch’ command.
IGNORE_LIST: ignore list on ‘switch’ command.
HISTORY_FILENAME: name of file which stores input history.
IMAGE_SHIFT: left and right margin of image in ‘-iot’/’–image-on-term’ mode.
IMAGE_MAX_HEIGHT: max height of image in ‘-iot’/’–image-on-term’ mode.
USER_DOMAIN: user URL of Twitter Streaming API.
PUBLIC_DOMAIN: public URL of Twitter Streaming API.
SITE_DOMAIN: site URL of Twitter Streaming API.
FORMAT: display format for tweet and message.
- CLOCK_FORMAT: time format, see Python’s strftime format.
- DISPLAY: decide how tweet will be printed.
- #name: Twitter’s name
- #nick: Twitter’s screen name
- #clock: Datetime
- #rt_count: retweets count
- #fa_count: favorites count
- #id: ID
- #fav: favorited symbol
- #fav: favorited symbol
- #tweet: Tweet’s content
- #sender_name: Message’s sender name
- #sender_nick: Message’s sender screen name
- #to: ‘>>>’ symbol
- #recipient_name: Message’s recipient name
- #recipient_nick: Message’s recipient screen name
In every format, you can use unicode characters like \u2665. Mac users also can use emoji characters as well (Ex: ::zap::). See Emoji cheatsheet for details.
If you want to build a runnable version yourself, follow these simple steps
Get your Twitter application’s API key and secret
Fork github’s repo and clone in your system.
# 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 (cloned directory) virtualenv venv # Python3 users: use -p to specify python3 source venv/bin/activate pip install -e . which rainbowstream # /this-directory/venv/bin/rainbowstream # Remove ~/.rainbow_oauth if exists rainbowstream # local version of rainbowstream