refactoring
[rainbowstream.git] / README.rst
CommitLineData
3108149e 1Rainbow Stream\r
2--------------\r
3\r
b8c1f42a 4|Download| |Version|\r
c96321cc 5\r
3108149e 6Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
7favorite … and much more fun directly from terminal.\r
8\r
b8c1f42a
O
9This package build on the top of `Python Twitter Tool`_ and `Twitter\r
10API`_.\r
3108149e 11\r
12Screenshot\r
13----------\r
14\r
b8c1f42a 15|rainbowstream| |rainbowstreamIOT|\r
3108149e 16\r
17Install\r
18-------\r
19\r
20You will need Python 2.7+ and pip.\r
21\r
22.. code:: bash\r
23\r
24 pip install rainbowstream\r
25\r
26Usage\r
27-----\r
28\r
29The stream\r
30^^^^^^^^^^\r
31\r
32Just type\r
33\r
34.. code:: bash\r
35\r
36 rainbow\r
37\r
38and see your stream.\r
39\r
b8c1f42a
O
40I shipped a feature which can display **tweet’s images directly on\r
41terminal**. You can try it with:\r
4373c17c
O
42\r
43.. code:: bash\r
44\r
c1fa7c94 45 rainbow -iot # Or rainbow --image-on-term\r
4373c17c 46\r
3108149e 47In the first time you will be asked for authorization of Rainbow Stream\r
48app at Twitter. Just click the “Authorize access” button and paste PIN\r
b8c1f42a
O
49number to the terminal, the rainbow will start\r
50\r
3108149e 51\r
52The interactive mode\r
53^^^^^^^^^^^^^^^^^^^^\r
54\r
55While your personal stream is continued, you are also ready to tweet,\r
56search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 57the Enter key to see the help.\r
3108149e 58\r
59Input is in interactive mode. It means that you can use arrow key to\r
60move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 61suggestion. Input history from previous run is available as well.\r
3108149e 62\r
63Here is full list of supported command\r
64\r
eebc0ae6 65**Action Commands**\r
3108149e 66\r
eebc0ae6 67- ``trend`` will show global trending topics. ``trend US`` will show\r
b8c1f42a
O
68 trends in United States while ``trend JP Tokyo`` will show trends in\r
69 Tokyo/Japan.\r
3108149e 70\r
71- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
e2b81717 72 tweets.\r
3108149e 73\r
74- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
e2b81717
O
75 exactly 9 tweets.\r
76\r
b8c1f42a
O
77- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
78 mention tweets.\r
3108149e 79\r
80- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
b8c1f42a 81 rainbow is god’s promise to noah’*.\r
3108149e 82\r
83- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
84 each tweet beside the time.\r
85\r
86- ``fav 12`` will favorite the tweet with *[id=12]*.\r
87\r
88- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
89\r
90- ``del 12`` will delete tweet with *[id=12]*.\r
91\r
92- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
93\r
b8c1f42a
O
94- ``s #noah`` will search the word *‘noah’*. Result will come back with\r
95 highlight.\r
3108149e 96\r
d286f104
O
97- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
98\r
b8c1f42a
O
99- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
100 OS’s image viewer.\r
3108149e 101\r
b8c1f42a
O
102- ``ls fl`` will list all your followers (people who are following\r
103 you).\r
b8cc314c 104\r
105- ``ls fr`` will list all your friends (people who you are following).\r
106\r
b8c1f42a
O
107- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
108 messages.\r
e2b81717 109\r
b8c1f42a
O
110- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
111 messages.\r
e2b81717 112\r
b8c1f42a 113- ``trash 5`` will remove message with *[message\_id=5]*\r
e2b81717
O
114\r
115- ``whois @dtvd88`` will show profile of @dtvd88.\r
116\r
f5677fb1
O
117- ``fl @dtvd88`` will follow @dtvd88.\r
118\r
119- ``ufl @dtvd88`` will unfollow @dtvd88.\r
3108149e 120\r
121- ``h`` will show the help.\r
122\r
123- ``c`` will clear the screen.\r
124\r
125- ``q`` will quit.\r
126\r
eebc0ae6
O
127**Stream Commands**\r
128\r
b8c1f42a
O
129- ``switch public #AKB48`` will switch current stream to public stream\r
130 and track keyword ``AKB48``\r
eebc0ae6
O
131\r
132- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
133 to provide 2 list:\r
134\r
135 ``Only nicks`` decide what nicks will be include only.\r
136\r
b8c1f42a 137 ``Ignore nicks``\ decide what nicks will be exclude.\r
eebc0ae6
O
138\r
139- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
140 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
141\r
142- ``switch mine`` will switch current stream to personal stream. ``-f``\r
143 and ``-d`` will work as well.\r
144\r
3108149e 145For example see the screenshot above.\r
146\r
147Bug Report\r
148----------\r
149\r
b8c1f42a
O
150Please `create an issue`_ or contact me at\r
151[@dtvd88](https://twitter.com/dtvd88)\r
3108149e 152\r
153License\r
154-------\r
155\r
156Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
157details\r
158\r
159\r
160.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 161.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3108149e 162.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
b8c1f42a
O
163\r
164.. |Download| image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
165 :target: https://pypi.python.org/pypi/rainbowstream\r
166.. |Version| image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
167 :target: https://pypi.python.org/pypi/rainbowstream\r
168.. |rainbowstream| image:: ./screenshot/RainbowStream.png\r
169.. |rainbowstreamIOT| image:: ./screenshot/RainbowStreamIOT.png