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