Commit | Line | Data |
---|---|---|
c264071c | 1 | Rainbow Stream\r |
2 | --------------\r | |
3 | \r | |
4 | .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r | |
5 | :target: https://pypi.python.org/pypi/rainbowstream\r | |
6 | \r | |
7 | .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r | |
8 | :target: https://pypi.python.org/pypi/rainbowstream\r | |
9 | \r | |
10 | Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r | |
11 | favorite … and much more fun directly from terminal.\r | |
12 | \r | |
13 | This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r | |
14 | \r | |
c264071c | 15 | Install\r |
16 | -------\r | |
17 | \r | |
18 | You will need Python 2.7+ and pip.\r | |
19 | \r | |
20 | .. code:: bash\r | |
21 | \r | |
22 | sudo pip install rainbowstream\r | |
b84845b9 | 23 | \r |
c264071c | 24 | or try with a virtualenv\r |
25 | \r | |
26 | .. code:: bash\r | |
27 | \r | |
28 | sudo pip install virtualenv # skip if you already have virtualenv\r | |
b84845b9 | 29 | virtualenv venv\r |
c264071c | 30 | source venv/bin/activate # use the brand new virtualenv.\r |
31 | pip install rainbowstream\r | |
32 | \r | |
33 | Usage\r | |
34 | -----\r | |
35 | \r | |
36 | The stream\r | |
37 | ^^^^^^^^^^\r | |
38 | \r | |
39 | Just type\r | |
40 | \r | |
41 | .. code:: bash\r | |
42 | \r | |
43 | rainbow\r | |
44 | \r | |
45 | and see your stream.\r | |
46 | \r | |
47 | I shipped a feature which can display **tweet's images directly on terminal**.\r | |
48 | You can try it with:\r | |
49 | \r | |
50 | .. code:: bash\r | |
51 | \r | |
52 | rainbow -iot # Or rainbow --image-on-term\r | |
53 | \r | |
54 | In the first time you will be asked for authorization of Rainbow Stream\r | |
55 | app at Twitter. Just click the “Authorize access” button and paste PIN\r | |
56 | number to the terminal, the rainbow will start.\r | |
57 | \r | |
58 | The interactive mode\r | |
59 | ^^^^^^^^^^^^^^^^^^^^\r | |
60 | \r | |
61 | While your personal stream is continued, you are also ready to tweet,\r | |
62 | search, reply, retweet… directly from console. Simply type “h” and hit\r | |
63 | the Enter key to see the help.\r | |
64 | \r | |
65 | Input is in interactive mode. It means that you can use arrow key to\r | |
66 | move up and down history, tab-autocomplete or 2 tab to view available\r | |
67 | suggestion. Input history from previous run is available as well.\r | |
68 | \r | |
69 | Here is full list of supported command:\r | |
70 | \r | |
71 | **Explore Commands**\r | |
72 | \r | |
73 | - ``trend`` will show global trending topics. ``trend US`` will show\r | |
74 | trends in United States while ``trend JP Tokyo`` will show trends in\r | |
75 | Tokyo/Japan.\r | |
76 | \r | |
77 | - ``home`` will show your timeline. ``home 10`` will print exactly 10\r | |
78 | tweets.\r | |
79 | \r | |
80 | - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r | |
81 | mention tweets.\r | |
82 | \r | |
83 | - ``whois @dtvd88`` will show profile of @dtvd88.\r | |
84 | \r | |
85 | - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r | |
86 | exactly 9 tweets.\r | |
87 | \r | |
88 | - ``s #noah`` will search the word *‘noah’*. Result will come back with\r | |
89 | highlight.\r | |
90 | \r | |
91 | **Tweet Commands**\r | |
92 | \r | |
93 | - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r | |
94 | rainbow is god’s promise to noah’*.\r | |
95 | \r | |
96 | - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r | |
97 | each tweet beside the time.\r | |
98 | \r | |
99 | - ``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.\r | |
100 | \r | |
101 | - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r | |
102 | \r | |
103 | - ``fav 12`` will favorite the tweet with *[id=12]*.\r | |
104 | \r | |
105 | - ``ufav 12`` will unfavorite tweet with *[id=12]*.\r | |
106 | \r | |
107 | - ``del 12`` will delete tweet with *[id=12]*.\r | |
108 | \r | |
109 | - ``show image 12`` will show the image in tweet with *[id=12]* in your\r | |
110 | OS’s image viewer.\r | |
111 | \r | |
112 | **Direct Messages Commands**\r | |
113 | \r | |
114 | - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r | |
115 | messages.\r | |
116 | \r | |
117 | - ``sent`` will show sent messages. ``sent 7`` will show newest 7\r | |
118 | messages.\r | |
119 | \r | |
120 | - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r | |
121 | \r | |
122 | - ``trash 5`` will remove message with *[message\_id=5]*\r | |
123 | \r | |
124 | **Friends and followers Commands**\r | |
125 | \r | |
126 | - ``ls fl`` will list all your followers (people who are following\r | |
127 | you).\r | |
128 | \r | |
129 | - ``ls fr`` will list all your friends (people who you are following).\r | |
130 | \r | |
131 | - ``fl @dtvd88`` will follow @dtvd88.\r | |
132 | \r | |
133 | - ``ufl @dtvd88`` will unfollow @dtvd88.\r | |
134 | \r | |
135 | - ``mute @dtvd88`` will mute @dtvd88.\r | |
136 | \r | |
137 | - ``unmute @dtvd88`` will unmute @dtvd88.\r | |
138 | \r | |
139 | - ``muting`` will list muting users.\r | |
140 | \r | |
141 | - ``block @dtvd88`` will block @dtvd88.\r | |
142 | \r | |
143 | - ``unblock @dtvd88`` will unblock @dtvd88.\r | |
144 | \r | |
145 | - ``report @dtvd88`` will report @dtvd88 as a spam account.\r | |
146 | \r | |
147 | **Switching Stream Commands**\r | |
148 | \r | |
149 | - ``switch public #AKB48`` will switch current stream to public stream\r | |
150 | and track keyword ``AKB48``\r | |
151 | \r | |
152 | - ``switch public #AKB48 -f`` will do exactly as above but will ask you\r | |
153 | to provide 2 list:\r | |
154 | \r | |
155 | ``Only nicks`` decide what nicks will be include only.\r | |
156 | \r | |
157 | ``Ignore nicks``\ decide what nicks will be exclude.\r | |
158 | \r | |
159 | - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r | |
160 | *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r | |
161 | \r | |
162 | - ``switch mine`` will switch current stream to personal stream. ``-f``\r | |
163 | and ``-d`` will work as well.\r | |
164 | \r | |
165 | **Smart shell**\r | |
166 | \r | |
167 | - Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r | |
168 | \r | |
169 | + ``142857*2`` or ``101**3`` like a calculator.\r | |
170 | + Even ``cal`` will show the calendar for current month.\r | |
171 | + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r | |
172 | \r | |
173 | **Screening Commands**\r | |
174 | \r | |
b84845b9 O |
175 | - ``theme`` will list available themes. ``theme monokai`` will apply *monokai*\r |
176 | theme immedaitely.\r | |
177 | \r | |
c264071c | 178 | - ``h`` will show the help.\r |
179 | \r | |
180 | - ``c`` will clear the screen.\r | |
181 | \r | |
182 | - ``q`` will quit.\r | |
183 | \r | |
184 | \r | |
c264071c | 185 | \r |
186 | \r | |
187 | .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r | |
188 | .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r |