bumped version
[rainbowstream.git] / README.rst
CommitLineData
3108149e 1Rainbow Stream\r
2--------------\r
3\r
3216f3f4
O
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
c96321cc 9\r
3108149e 10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
3216f3f4 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
3108149e 14\r
456019d6 15Showcase\r
3108149e 16----------\r
456019d6
O
17Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
18\r
19Screenshot: \r
3108149e 20\r
3216f3f4
O
21.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
22 :alt: rainbowstream\r
23\r
24.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
25 :alt: rainbowstreamIOT\r
3108149e 26\r
27Install\r
28-------\r
29\r
30You will need Python 2.7+ and pip.\r
31\r
32.. code:: bash\r
33\r
34 pip install rainbowstream\r
35\r
36Usage\r
37-----\r
38\r
39The stream\r
40^^^^^^^^^^\r
41\r
42Just type\r
43\r
44.. code:: bash\r
45\r
46 rainbow\r
47\r
48and see your stream.\r
49\r
3216f3f4
O
50I shipped a feature which can display **tweet's images directly on terminal**.\r
51You can try it with:\r
4373c17c
O
52\r
53.. code:: bash\r
54\r
c1fa7c94 55 rainbow -iot # Or rainbow --image-on-term\r
4373c17c 56\r
3108149e 57In the first time you will be asked for authorization of Rainbow Stream\r
58app at Twitter. Just click the “Authorize access” button and paste PIN\r
3216f3f4 59number to the terminal, the rainbow will start.\r
3108149e 60\r
61The interactive mode\r
62^^^^^^^^^^^^^^^^^^^^\r
63\r
64While your personal stream is continued, you are also ready to tweet,\r
65search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 66the Enter key to see the help.\r
3108149e 67\r
68Input is in interactive mode. It means that you can use arrow key to\r
69move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 70suggestion. Input history from previous run is available as well.\r
3108149e 71\r
a38a6465 72Here is full list of supported command:\r
3108149e 73\r
a38a6465 74**Explore Commands**\r
3108149e 75\r
eebc0ae6 76- ``trend`` will show global trending topics. ``trend US`` will show\r
a38a6465
O
77 trends in United States while ``trend JP Tokyo`` will show trends in\r
78 Tokyo/Japan.\r
3108149e 79\r
80- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
e2b81717 81 tweets.\r
3108149e 82\r
a38a6465
O
83- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
84 mention tweets.\r
85\r
86- ``whois @dtvd88`` will show profile of @dtvd88.\r
87\r
3108149e 88- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
e2b81717
O
89 exactly 9 tweets.\r
90\r
a38a6465
O
91- ``s #noah`` will search the word *‘noah’*. Result will come back with\r
92 highlight.\r
93\r
94**Tweet Commands**\r
3108149e 95\r
96- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
a38a6465 97 rainbow is god’s promise to noah’*.\r
3108149e 98\r
99- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
100 each tweet beside the time.\r
101\r
a38a6465
O
102- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
103\r
3108149e 104- ``fav 12`` will favorite the tweet with *[id=12]*.\r
105\r
a38a6465 106- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
3108149e 107\r
108- ``del 12`` will delete tweet with *[id=12]*.\r
109\r
a38a6465
O
110- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
111 OS’s image viewer.\r
112\r
113**Direct Messages Commands**\r
114\r
115- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
116 messages.\r
3108149e 117\r
a38a6465
O
118- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
119 messages.\r
3108149e 120\r
d286f104
O
121- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
122\r
a38a6465 123- ``trash 5`` will remove message with *[message\_id=5]*\r
3108149e 124\r
a38a6465
O
125**Friends and followers Commands**\r
126\r
127- ``ls fl`` will list all your followers (people who are following\r
128 you).\r
b8cc314c 129\r
130- ``ls fr`` will list all your friends (people who you are following).\r
131\r
a38a6465 132- ``fl @dtvd88`` will follow @dtvd88.\r
e2b81717 133\r
a38a6465 134- ``ufl @dtvd88`` will unfollow @dtvd88.\r
e2b81717 135\r
a38a6465 136- ``mute @dtvd88`` will mute @dtvd88.\r
e2b81717 137\r
a38a6465 138- ``unmute @dtvd88`` will unmute @dtvd88.\r
e2b81717 139\r
a38a6465 140- ``muting`` will list muting users.\r
f5677fb1 141\r
a38a6465
O
142- ``block @dtvd88`` will block @dtvd88.\r
143\r
144- ``unblock @dtvd88`` will unblock @dtvd88.\r
145\r
146- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
147\r
148**Screening Commands**\r
3108149e 149\r
150- ``h`` will show the help.\r
151\r
152- ``c`` will clear the screen.\r
153\r
154- ``q`` will quit.\r
155\r
a38a6465 156**Switching Stream Commands**\r
eebc0ae6 157\r
a38a6465
O
158- ``switch public #AKB48`` will switch current stream to public stream\r
159 and track keyword ``AKB48``\r
eebc0ae6
O
160\r
161- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
162 to provide 2 list:\r
163\r
164 ``Only nicks`` decide what nicks will be include only.\r
165\r
a38a6465 166 ``Ignore nicks``\ decide what nicks will be exclude.\r
eebc0ae6
O
167\r
168- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
169 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
170\r
171- ``switch mine`` will switch current stream to personal stream. ``-f``\r
172 and ``-d`` will work as well.\r
173\r
76cfdd25
O
174**Smart shell**\r
175\r
176- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
177\r
178 + ``142857*2`` or ``101**3`` like a calculator.\r
179 + Even ``cal`` will show the calendar for current month.\r
180 + Put ``order_rainbow('anything')`` or ``random_rainow('wahahaha')`` will make more fun :)\r
3216f3f4 181\r
a38a6465 182\r
3108149e 183For example see the screenshot above.\r
184\r
050c4214 185Bug and feature requests\r
3108149e 186----------\r
187\r
050c4214 188Found a bug or a feature request ? \r
3216f3f4 189Please `create an issue`_ or contact me at `@dtvd88`_\r
3108149e 190\r
050c4214
O
191Contributing\r
192----------\r
193I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
194You will be listed as contributor.\r
195\r
3108149e 196License\r
197-------\r
198\r
199Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
200details\r
201\r
202\r
203.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 204.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3216f3f4 205.. _EarthQuake: https://github.com/jugyo/earthquake\r
3108149e 206.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
3216f3f4 207.. _@dtvd88: https://twitter.com/dtvd88\r
050c4214
O
208.. _fork: https://github.com/DTVD/rainbowstream/fork\r
209.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r