Update README.rst
[rainbowstream.git] / docs / index.rst
CommitLineData
c264071c 1Rainbow 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
10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
14\r
c264071c 15Install\r
16-------\r
17\r
18You 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 24or 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
33Usage\r
34-----\r
35\r
36The stream\r
37^^^^^^^^^^\r
38\r
39Just type\r
40\r
41.. code:: bash\r
42\r
aa835f48 43 rainbowstream\r
c264071c 44\r
45and see your stream.\r
46\r
47I shipped a feature which can display **tweet's images directly on terminal**.\r
48You can try it with:\r
49\r
50.. code:: bash\r
51\r
aa835f48 52 rainbowstream -iot # Or rainbowstream --image-on-term\r
c264071c 53\r
54In the first time you will be asked for authorization of Rainbow Stream\r
55app at Twitter. Just click the “Authorize access” button and paste PIN\r
56number to the terminal, the rainbow will start.\r
57\r
58The interactive mode\r
59^^^^^^^^^^^^^^^^^^^^\r
60\r
61While your personal stream is continued, you are also ready to tweet,\r
62search, reply, retweet… directly from console. Simply type “h” and hit\r
63the Enter key to see the help.\r
64\r
65Input is in interactive mode. It means that you can use arrow key to\r
66move up and down history, tab-autocomplete or 2 tab to view available\r
67suggestion. Input history from previous run is available as well.\r
68\r
69Here 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
162af8aa
O
99- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
100 the quote will be cancelled.\r
101\r
c264071c 102- ``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
103\r
104- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
105\r
106- ``fav 12`` will favorite the tweet with *[id=12]*.\r
107\r
108- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
109\r
110- ``del 12`` will delete tweet with *[id=12]*.\r
111\r
112- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
113 OS’s image viewer.\r
114\r
162af8aa
O
115- ``open 12`` will open url in tweet with *[id=12]* in your\r
116 OS’s default browser.\r
117\r
c264071c 118**Direct Messages Commands**\r
119\r
120- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
121 messages.\r
122\r
123- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
124 messages.\r
125\r
126- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
127\r
128- ``trash 5`` will remove message with *[message\_id=5]*\r
129\r
130**Friends and followers Commands**\r
131\r
132- ``ls fl`` will list all your followers (people who are following\r
133 you).\r
134\r
135- ``ls fr`` will list all your friends (people who you are following).\r
136\r
137- ``fl @dtvd88`` will follow @dtvd88.\r
138\r
139- ``ufl @dtvd88`` will unfollow @dtvd88.\r
140\r
141- ``mute @dtvd88`` will mute @dtvd88.\r
142\r
143- ``unmute @dtvd88`` will unmute @dtvd88.\r
144\r
145- ``muting`` will list muting users.\r
146\r
147- ``block @dtvd88`` will block @dtvd88.\r
148\r
149- ``unblock @dtvd88`` will unblock @dtvd88.\r
150\r
151- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
152\r
153**Switching Stream Commands**\r
154\r
155- ``switch public #AKB48`` will switch current stream to public stream\r
156 and track keyword ``AKB48``\r
157\r
158- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
159 to provide 2 list:\r
160\r
161 ``Only nicks`` decide what nicks will be include only.\r
162\r
163 ``Ignore nicks``\ decide what nicks will be exclude.\r
164\r
165- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
166 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
167\r
168- ``switch mine`` will switch current stream to personal stream. ``-f``\r
169 and ``-d`` will work as well.\r
170\r
171**Smart shell**\r
172\r
173- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
174\r
175 + ``142857*2`` or ``101**3`` like a calculator.\r
176 + Even ``cal`` will show the calendar for current month.\r
177 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
178\r
179**Screening Commands**\r
180\r
b6cddcd5
O
181- ``theme`` will list available themes. \r
182 \r
183 + ``theme monokai`` will apply *monokai* theme immedaitely.\r
184 + ``theme current_as_default`` will remember current theme as next time default.\r
185 \r
c264071c 186- ``h`` will show the help.\r
187\r
188- ``c`` will clear the screen.\r
189\r
190- ``q`` will quit.\r
191\r
e5057f23 192Available commands are listed in `Read The Docs`_.\r
c264071c 193\r
e5057f23
O
194Theme customization\r
195^^^^^^^^^^^^^^^^^^^\r
196\r
06302419 197Rainbow Stream is shipped with some default themes.\r
e5057f23
O
198You can either change theme by ``theme`` command or create your favorite one.\r
199\r
155083ad
O
200Theme’s screenshot:\r
201\r
3681056d
O
202- Monokai\r
203\r
155083ad
O
204.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
205 :alt: monokai\r
206\r
3681056d
O
207- Solarized\r
208\r
155083ad
O
209.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
210 :alt: solarized\r
211\r
3681056d
O
212- Tomorrow Night\r
213\r
aa835f48
O
214.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
215 :alt: tomorrownight\r
216\r
3681056d
O
217- Larapaste\r
218\r
aa835f48
O
219.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
220 :alt: larapaste\r
221\r
e5057f23 222For detaile information, see `theme usage and customization`_.\r
c264071c 223\r
224\r
225.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
226.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
e5057f23 227.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r