- +

ShowcaseÂ¶

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

Screenshot:

This package is built on the top of Python Twitter Tool and Twitter API, +can run on Python 2.7.x and 3.x .

InstallÂ¶

You will need Python 2.7+ and pip.

The quick wayÂ¶

You will need Python and pip (2.7.x or 3.x).

sudo pip install rainbowstream
+# Python 3 users: sudo pip3 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.
+

The recommended wayÂ¶

Use virtualenv

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
 

UsageÂ¶

The streamÂ¶

Just type

rainbow
+rainbowstream
 
 
 and see your stream.
 I shipped a feature which can display tweet’s images directly on terminal.
 You can try it with:
-rainbow -iot # Or rainbow --image-on-term
+rainbowstream -iot # Or rainbowstream --image-on-term
 
 
 In the first time you will be asked for authorization of Rainbow Stream
@@ -113,8 +120,8 @@ mention tweets.
 
whois @dtvd88 will show profile of @dtvd88.
 view @mdo will show @mdo âs timeline. view @dmo 9 will print
 exactly 9 tweets.
-s #noah will search the word ânoahâ. Result will come back with
-highlight.
+s noah will search the word ânoahâ. Result will come back with
+highlight. Search can be performed with or without hashtag.
 
 Tweet Commands
 
@@ -122,6 +129,8 @@ highlight.
 rainbow is godâs promise to noahâ.
 rt 12 will retweet the tweet with [id=12]. You can see id of
 each tweet beside the time.
+quote 12 will quote the tweet with [id=12]. If no extra text is added,
+the quote will be cancelled.
 allrt 12 20 will list 20 newest retweets of the tweet with [id=12]. If the number of retweets is not specified, 5 newest retweets will be listed instead.
 rep 12 Really will reply âReallyâ to the tweet with [id=12].
 fav 12 will favorite the tweet with [id=12].
@@ -129,6 +138,8 @@ each tweet beside the time.
 del 12 will delete tweet with [id=12].
 show image 12 will show the image in tweet with [id=12] in your
 OSâs image viewer.
+open 12 will open url in tweet with [id=12] in your
+OSâs default browser.
 
 Direct Messages Commands
 
@@ -153,6 +164,21 @@ you).
 unblock @dtvd88 will unblock @dtvd88.
 report @dtvd88 will report @dtvd88 as a spam account.
 
+Twitter list
+
+list will show all lists you are belong to.
+list home will show timeline of list. You will be asked for list’s name.
+list all_mem will show list’s all members.
+list all_sub will show list’s all subscribers.
+list add will add specific person to a list owned by you.
+list rm will remove specific person from a list owned by you.
+list sub will subscribe you to a specific list.
+list unsub will unsubscribe you from a specific list.
+list own will show all list owned by you.
+list new will create a new list.
+list update will update a list owned by you.
+list del will delete a list owned by you.
+
 Switching Stream Commands
 
 switch public #AKB48 will switch current stream to public stream
@@ -179,29 +205,121 @@ and -d will work as w
 
 
 
+Config Management
+
+theme will list available themes.
+
+
+
+theme monokai will apply monokai theme immedaitely.
+theme current_as_default will remember current theme as next time default.
+
+
+
+config will list all config key.
+
+
+
+config ASCII_ART will output current value of ASCII_ART config key.
+config ASCII_ART default will output default value of ASCII_ART config key.
+config ASCII_ART = False will set value of ASCII_ART config key to False.
+
+
 Screening Commands
 
 h will show the help.
 c will clear the screen.
 q will quit.
 
-For example see the screenshot above.
+Available commands are listed in `Read The Docs`_.
 
+
+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
+
+
+
 
-
-Bug and feature requestsÂ¶
-Found a bug or a feature request ?
-Please create an issue or contact me at @dtvd88
+
+Solarized
+
+
+
 
-
-ContributingÂ¶
-I appreciate any help and support. Feel free to fork and create a pull request.
-You will be listed as contributor.
+
+Tomorrow Night
+
+
+
+
+
+Larapaste
+
+
+
 
-
-LicenseÂ¶
-Rainbow Stream are released under an MIT License. See LICENSE.txt for
-details
+For detaile information, see theme usage and customization.
+
+
+Config explanationÂ¶
+Rainbow Stream has a config file located at ~/.rainbow_config.json.
+You can view or set a new value of every config key by config command (See Interactive mode section above).
+
+THEME: current theme.
+ASCII_ART: diplay your twitter name by ascii art at stream begin or not.
+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.
+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.
+
+
+
+
+DevelopmentÂ¶
+If you want to build a runnable version yourself, follow these simple
+steps
+
+Create your own Twitter Application
+
+Get your Twitter applicationâs API key and secret
+
+Fork github’s repo and clone in your system.
+
+Create a file consumer.py in ```rainbowstream```_ folder with
+following content
+# 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
+pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
+# Remove ~/.rainbow_oauth if exists
+rainbowstream # local version of rainbowstream
+
+
+
+
 
 
 
@@ -213,18 +331,25 @@ details
   Table Of Contents
   
 Rainbow Stream
-Showcase
-Install
+Install
+The quick way
+The recommended way
+
+
 Usage
 The stream
 The interactive mode
+Theme customization
+Config explanation
 
 
-Bug and feature requests
-Contributing
-License
+Development
+
+Related Topics
+
+  Documentation overview
+  
 
-
   This Page
   
     
       

       
     

-    
-      Navigation
-      
-        
-          index
-        Rainbow Stream 0.1.0 documentation » 
-      
-    
-    
-        © Copyright 2014, Vu Nhat Minh.
-      Created using Sphinx 1.2.2.
-    
+  
+    © Copyright 2014, Vu Nhat Minh.
+    Created using Sphinx.
+  
+  
+  
+  
   
 
\ No newline at end of file
diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
index 64db9f80e3ffe811d3b64d232870b58740284607..37770f4c9bcaa658aaa24ea1e7eb9352da79154f 100644
GIT binary patch
delta 16
Xcmcb@c$sm6{zL;2W)nT*iSE4sFMNl|KIE|;=GSZYymW`3TPf`Oi)p20-7UI4|13hMv>

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
index 734df8c..7c23d36 100644
--- a/docs/_build/html/search.html
+++ b/docs/_build/html/search.html
@@ -6,15 +6,15 @@
   
     
     
-    Search — Rainbow Stream 0.1.0 documentation
+    Search — RainbowStream 0.4.3 documentation
     
-    
+    
     
     
     
     
     
-    
+    
   
   
   
+  
    
+  
+  
+
 
   
   
+  
+  
+
     
       Navigation
       
         
           index
-        Rainbow Stream 0.1.0 documentation » 
+        RainbowStream 0.4.3 documentation » 
       
       
 
@@ -77,23 +84,19 @@

Related Topics

Documentation overview

- - + + \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index f7e7616..1eba34f 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{all:0,newest:0,help:0,just:0,show:0,api:0,skip:0,unfollow:0,move:0,unfavorit:0,month:0,unblock:0,tweetstream:0,follow:0,profil:0,onli:0,noah:0,also:0,tweet:0,mute:0,activ:0,send:0,under:0,input:0,smart:0,bin:0,sourc:0,hit:0,python:0,watch:0,number:0,mention:0,promis:0,command:0,report:0,youtub:0,term:0,rainbowstream:0,like:0,anyth:0,realtim:0,button:0,list:0,ignore_list:0,"public":0,"try":0,screencast:0,arrow:0,each:0,found:0,remov:0,mean:0,pleas:0,www:0,mdo:0,trend:0,twitter:0,timelin:0,continu:0,realli:0,past:0,see:0,result:0,japan:0,home:0,calendar:0,histori:0,retweet:0,virtualenv:0,allrt:0,repli:0,rep:0,ufav:0,"while":0,access:0,delet:0,state:0,akb48:0,print:0,"new":0,message_id:0,iot:0,can:0,full:0,run:0,appreci:0,kei:0,screen:0,decid:0,here:0,fun:0,base:0,free:0,ask:0,come:0,search:0,current:0,filter:0,view:0,com:0,top:0,block:0,first:0,tykcvpmjq8:0,client:0,venv:0,simpli:0,directli:0,feel:0,appli:0,app:0,wahahaha:0,down:0,put:0,alreadi:0,global:0,inbox:0,contributor:0,txt:0,your:0,unit:0,enter:0,quit:0,from:0,pin:0,spam:0,support:0,compos:0,messag:0,avail:0,start:0,much:0,besid:0,includ:0,time:0,termin:0,type:0,friend:0,whoi:0,fork:0,shell:0,consol:0,peopl:0,brand:0,specifi:0,back:0,only_list:0,exactli:0,pull:0,account:0,word:0,have:0,keyword:0,tokyo:0,provid:0,setup:0,work:0,displai:0,dmo:0,calcul:0,del:0,sent:0,abov:0,cal:0,autocomplet:0,highlight:0,more:0,order_rainbow:0,tab:0,creat:0,viewer:0,favorit:0,sudo:0,mine:0,topic:0,dtvd88:0,explor:0,pip:0,ship:0,unmut:0,packag:0,readi:0,built:0,author:0,suggest:0,make:0,detail:0,who:0,click:0,random_rainbow:0,nick:0,need:0,exampl:0,ufl:0,which:0,instead:0,you:0,trash:0,config:0,imag:0,even:0,http:0,screenshot:0,track:0,fav:0,previou:0,tool:0,what:0,releas:0,user:0,eval:0,mit:0,ani:0,direct:0,clear:0,well:0,exclud:0,issu:0,person:0,"switch":0,contact:0,ignor:0,thi:0,god:0},objtypes:{},objnames:{},filenames:["index"],titles:["Rainbow Stream"],objects:{},titleterms:{rainbow:0,featur:0,contribut:0,stream:0,showcas:0,interact:0,usag:0,request:0,bug:0,mode:0,instal:0,licens:0}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{all:0,newest:0,help:0,noah:0,show:0,skip:[],unfollow:0,consum:0,unfavorit:0,month:0,unblock:0,tweetstream:0,url:0,follow:0,config:[],larapast:0,content:0,onli:0,locat:0,just:0,explor:0,nick:0,tweet:0,mute:0,activ:0,send:0,only_list:0,add:0,akb48:0,tool:0,text:0,input:0,folder:0,local:0,smart:0,bin:0,applic:0,move:0,hit:0,which:0,unsubscrib:0,python:0,list_max:0,watch:[],wahahaha:0,repo:0,mention:0,promis:0,usr:0,instead:0,report:0,word:0,height:0,youtub:[],runnabl:0,python3:0,name:0,term:0,rainbowstream:0,like:0,specif:0,anyth:0,even:0,realtim:0,button:0,list:0,ignore_list:0,message_id:0,"try":0,provid:0,screencast:[],either:0,arrow:0,each:0,all_mem:0,found:[],manag:0,mean:0,pleas:[],shell:0,www:[],set:0,art:0,mdo:0,trend:0,twitter:0,timelin:0,some:0,continu:0,realli:0,past:0,contributor:[],see:0,previou:0,result:0,japan:0,home:0,calendar:0,dmo:0,retweet:0,appreci:[],virtualenv:0,allrt:0,friend:0,sub:0,mine:0,repli:0,rep:0,ufav:0,below:0,your:0,profil:0,delet:0,state:0,version:0,right:0,contact:[],print:0,"new":0,get:0,trend_max:0,"public":0,full:0,run:0,image_max_height:0,kei:0,retweets_show_num:0,screen:0,night:0,decid:0,here:0,consumer_secret:0,autocomplet:0,step:0,base:0,free:[],output:0,ask:0,come:0,ignor:0,valu:0,suggest:0,search:0,mit:[],god:0,current:0,fav:0,filter:0,person:0,public_domain:0,fals:0,chang:0,view:0,com:[],support:0,block:0,first:0,tykcvpmjq8:[],own:0,simpli:0,directli:0,extra:0,feel:[],appli:0,app:0,number:0,yourself:0,down:0,put:0,ascii_art:0,api:0,rainbow_config:0,inbox:0,json:0,cancel:0,diplai:0,txt:[],open:0,tomorrow:0,unit:0,quit:0,from:0,creat:0,spam:0,top:0,system:0,messag:0,next:0,avail:0,start:0,secret:0,much:0,besid:0,compos:0,subscrib:0,exampl:[],termin:0,type:0,store:0,includ:0,search_max_record:0,setup:0,site_domain:0,consol:0,apisecret:0,venv:0,peopl:0,brand:[],under:[],specifi:0,consumer_kei:0,solar:0,hashtag:0,alreadi:[],exactli:0,sent:0,pull:[],account:0,calcul:0,grep:0,have:[],keyword:0,tokyo:0,"default":0,remov:0,access:0,displai:0,section:0,histori:0,directori:0,"while":0,apikei:0,del:0,can:0,abov:0,cal:0,fun:0,highlight:0,more:0,margin:0,order_rainbow:0,browser:0,fork:0,messages_displai:0,want:0,pin:0,direct:0,viewer:0,image_shift:0,sudo:0,site:0,ani:[],topic:0,pip:0,sourc:0,exist:0,file:0,localt:0,dtvd88:0,everi:0,ship:0,work:0,ascii:0,well:0,packag:0,tab:0,readi:0,random_rainbow:0,built:0,pip3:0,author:0,perform:0,unmut:0,make:0,belong:0,detail:0,who:0,click:0,member:0,also:0,need:0,client:0,ufl:0,build:0,rememb:0,contain:0,global:0,current_as_default:0,trash:0,simpl:0,imag:0,updat:0,monokai:0,begin:0,http:[],time:0,screenshot:0,track:0,max:0,clone:0,iot:0,home_tweet_num:0,what:0,history_filenam:0,releas:[],user:0,eval:0,thi:0,unsub:0,rainbow_oauth:0,immedait:0,all_sub:0,github:0,whoi:0,read:0,doc:0,clear:0,quot:0,favorit:0,exclud:0,issu:[],inform:0,"switch":0,without:0,command:0,back:0,enter:0,user_domain:0,you:0,left:0},objtypes:{},objnames:{},filenames:["index"],titles:["Rainbow Stream"],objects:{},titleterms:{explan:0,rainbow:0,featur:[],develop:0,contribut:[],stream:0,showcas:[],interact:0,licens:[],usag:0,request:[],custom:0,theme:0,wai:0,mode:0,recommend:0,quick:0,instal:0,config:0,bug:[]}}) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 956e8ad..f9cad4b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # -# Rainbow Stream documentation build configuration file, created by -# sphinx-quickstart on Mon Jun 30 17:12:05 2014. +# RainbowStream documentation build configuration file, created by +# sphinx-quickstart on Wed Jul 23 12:26:18 2014. # # This file is execfile()d with the current directory set to its # containing dir. @@ -14,6 +14,7 @@ import sys import os +sys.path.append(os.path.abspath('_themes')) # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -43,7 +44,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Rainbow Stream' +project = u'RainbowStream' copyright = u'2014, Vu Nhat Minh' # The version info for the project you're documenting, acts as replacement for @@ -98,7 +99,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -sys.path.append(os.path.abspath('_themes')) +#html_theme = 'default' html_theme_path = ['_themes'] html_theme = 'flask' @@ -198,7 +199,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'RainbowStream.tex', u'Rainbow Stream Documentation', + ('index', 'RainbowStream.tex', u'RainbowStream Documentation', u'Vu Nhat Minh', 'manual'), ] @@ -228,7 +229,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'rainbowstream', u'Rainbow Stream Documentation', + ('index', 'rainbowstream', u'RainbowStream Documentation', [u'Vu Nhat Minh'], 1) ] @@ -242,7 +243,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'RainbowStream', u'Rainbow Stream Documentation', + ('index', 'RainbowStream', u'RainbowStream Documentation', u'Vu Nhat Minh', 'RainbowStream', 'One line description of project.', 'Miscellaneous'), ] -- 2.25.1

Navigation

Related Topics

Quick search

Navigation

Navigation

ShowcaseÂ¶

InstallÂ¶

The quick wayÂ¶

The recommended wayÂ¶

UsageÂ¶

The streamÂ¶

Theme customizationÂ¶

Bug and feature requestsÂ¶

ContributingÂ¶

LicenseÂ¶

Config explanationÂ¶

DevelopmentÂ¶

Table Of Contents

Related Topics

This Page

Navigation

Navigation

Related Topics

Navigation