Update theme.md
[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
2dd80ec9 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
14can run on Python 2.7.x and 3.4.x .\r
c264071c 15\r
c264071c 16Install\r
17-------\r
18\r
0dc0dd00
O
19The quick way\r
20^^^^^^^^^^^^^\r
21\r
8b076818 22You will need Python and pip (2.7.x or 3.x).\r
c264071c 23\r
24.. code:: bash\r
25\r
26 sudo pip install rainbowstream\r
8b076818 27 # Python 3 users: sudo pip3 install rainbowstream\r
b84845b9 28\r
0dc0dd00
O
29The recommended way\r
30^^^^^^^^^^^^^^^^^^^\r
b84845b9 31\r
0dc0dd00 32Use `virtualenv`_\r
c264071c 33\r
34.. code:: bash\r
35\r
b84845b9 36 virtualenv venv\r
0dc0dd00
O
37 # Python 3 users : use -p to specify your Python 3 localtion as below\r
38 # virtualenv -p /usr/bin/python3 venv\r
39 source venv/bin/activate\r
c264071c 40 pip install rainbowstream\r
41\r
0dc0dd00 42\r
c264071c 43Usage\r
44-----\r
45\r
46The stream\r
47^^^^^^^^^^\r
48\r
49Just type\r
50\r
51.. code:: bash\r
52\r
aa835f48 53 rainbowstream\r
c264071c 54\r
55and see your stream.\r
56\r
57I shipped a feature which can display **tweet's images directly on terminal**.\r
58You can try it with:\r
59\r
60.. code:: bash\r
61\r
aa835f48 62 rainbowstream -iot # Or rainbowstream --image-on-term\r
c264071c 63\r
64In the first time you will be asked for authorization of Rainbow Stream\r
65app at Twitter. Just click the “Authorize access” button and paste PIN\r
66number to the terminal, the rainbow will start.\r
67\r
68The interactive mode\r
69^^^^^^^^^^^^^^^^^^^^\r
70\r
71While your personal stream is continued, you are also ready to tweet,\r
72search, reply, retweet… directly from console. Simply type “h” and hit\r
73the Enter key to see the help.\r
74\r
75Input is in interactive mode. It means that you can use arrow key to\r
76move up and down history, tab-autocomplete or 2 tab to view available\r
77suggestion. Input history from previous run is available as well.\r
78\r
79Here is full list of supported command:\r
80\r
81**Explore Commands**\r
82\r
83- ``trend`` will show global trending topics. ``trend US`` will show\r
84 trends in United States while ``trend JP Tokyo`` will show trends in\r
85 Tokyo/Japan.\r
86\r
87- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
88 tweets.\r
89\r
90- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
91 mention tweets.\r
92\r
93- ``whois @dtvd88`` will show profile of @dtvd88.\r
94\r
95- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
96 exactly 9 tweets.\r
97\r
98- ``s #noah`` will search the word *‘noah’*. Result will come back with\r
99 highlight.\r
100\r
101**Tweet Commands**\r
102\r
103- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
104 rainbow is god’s promise to noah’*.\r
105\r
106- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
107 each tweet beside the time.\r
108\r
162af8aa
O
109- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
110 the quote will be cancelled.\r
111\r
c264071c 112- ``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
113\r
114- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
115\r
116- ``fav 12`` will favorite the tweet with *[id=12]*.\r
117\r
118- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
119\r
120- ``del 12`` will delete tweet with *[id=12]*.\r
121\r
122- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
123 OS’s image viewer.\r
124\r
162af8aa
O
125- ``open 12`` will open url in tweet with *[id=12]* in your\r
126 OS’s default browser.\r
127\r
c264071c 128**Direct Messages Commands**\r
129\r
130- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
131 messages.\r
132\r
133- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
134 messages.\r
135\r
136- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
137\r
138- ``trash 5`` will remove message with *[message\_id=5]*\r
139\r
140**Friends and followers Commands**\r
141\r
142- ``ls fl`` will list all your followers (people who are following\r
143 you).\r
144\r
145- ``ls fr`` will list all your friends (people who you are following).\r
146\r
147- ``fl @dtvd88`` will follow @dtvd88.\r
148\r
149- ``ufl @dtvd88`` will unfollow @dtvd88.\r
150\r
151- ``mute @dtvd88`` will mute @dtvd88.\r
152\r
153- ``unmute @dtvd88`` will unmute @dtvd88.\r
154\r
155- ``muting`` will list muting users.\r
156\r
157- ``block @dtvd88`` will block @dtvd88.\r
158\r
159- ``unblock @dtvd88`` will unblock @dtvd88.\r
160\r
161- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
162\r
bef33491
O
163**Twitter list**\r
164\r
165- ``list`` will show all lists you are belong to.\r
166\r
167- ``list home`` will show timeline of list. You will be asked for list's name.\r
168\r
169- ``list all_mem`` will show list's all members.\r
170\r
171- ``list all_sub`` will show list's all subscribers.\r
172\r
173- ``list add`` will add specific person to a list owned by you.\r
bef33491
O
174\r
175- ``list rm`` will remove specific person from a list owned by you.\r
bef33491
O
176\r
177- ``list sub`` will subscribe you to a specific list.\r
178\r
179- ``list unsub`` will unsubscribe you from a specific list.\r
180\r
181- ``list own`` will show all list owned by you.\r
182\r
183- ``list new`` will create a new list.\r
184\r
185- ``list update`` will update a list owned by you.\r
186\r
187- ``list del`` will delete a list owned by you.\r
188\r
c264071c 189**Switching Stream Commands**\r
190\r
191- ``switch public #AKB48`` will switch current stream to public stream\r
192 and track keyword ``AKB48``\r
193\r
194- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
195 to provide 2 list:\r
196\r
197 ``Only nicks`` decide what nicks will be include only.\r
198\r
199 ``Ignore nicks``\ decide what nicks will be exclude.\r
200\r
201- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
202 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
203\r
204- ``switch mine`` will switch current stream to personal stream. ``-f``\r
205 and ``-d`` will work as well.\r
206\r
207**Smart shell**\r
208\r
209- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
210\r
211 + ``142857*2`` or ``101**3`` like a calculator.\r
212 + Even ``cal`` will show the calendar for current month.\r
213 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
214\r
215**Screening Commands**\r
216\r
2d341029
O
217- ``theme`` will list available themes.\r
218\r
b6cddcd5
O
219 + ``theme monokai`` will apply *monokai* theme immedaitely.\r
220 + ``theme current_as_default`` will remember current theme as next time default.\r
2d341029 221\r
c264071c 222- ``h`` will show the help.\r
223\r
224- ``c`` will clear the screen.\r
225\r
226- ``q`` will quit.\r
227\r
e5057f23 228Available commands are listed in `Read The Docs`_.\r
c264071c 229\r
e5057f23
O
230Theme customization\r
231^^^^^^^^^^^^^^^^^^^\r
232\r
06302419 233Rainbow Stream is shipped with some default themes.\r
e5057f23
O
234You can either change theme by ``theme`` command or create your favorite one.\r
235\r
155083ad
O
236Theme’s screenshot:\r
237\r
3681056d
O
238- Monokai\r
239\r
155083ad
O
240.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
241 :alt: monokai\r
242\r
3681056d
O
243- Solarized\r
244\r
155083ad
O
245.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
246 :alt: solarized\r
247\r
3681056d
O
248- Tomorrow Night\r
249\r
aa835f48
O
250.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
251 :alt: tomorrownight\r
252\r
3681056d
O
253- Larapaste\r
254\r
aa835f48
O
255.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
256 :alt: larapaste\r
257\r
e5057f23 258For detaile information, see `theme usage and customization`_.\r
c264071c 259\r
2d341029
O
260Development\r
261-----------\r
262\r
263If you want to build a runnable version yourself, follow these simple\r
264steps\r
265\r
266- `Create your own Twitter Application`_\r
267- Get your Twitter application’s API key and secret\r
9e1f9d56 268- Fork github's repo and clone in your system.\r
2d341029
O
269- Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
270 following content\r
271\r
272 .. code:: python\r
273\r
274 # Consumer information\r
275 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
276 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
277\r
278- Use pip to install in local\r
279\r
280 .. code:: bash\r
281\r
9e1f9d56 282 # cd to directory which contains setup.py (cloned directory)\r
2d341029
O
283 virtualenv venv # Python3 users: use -p to specify python3\r
284 source venv/bin/activate\r
285 pip install -e .\r
9e1f9d56
O
286 which rainbowstream # /this-directory/venv/bin/rainbowstream\r
287 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
288 # Remove ~/.rainbow_oauth if exists\r
2d341029 289 rainbowstream # local version of rainbowstream\r
c264071c 290\r
2d341029
O
291.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
292.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
c264071c 293.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
294.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
e5057f23 295.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
0dc0dd00 296.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r