leep gif
[rainbowstream.git] / README.rst
CommitLineData
3108149e 1Rainbow Stream\r
2--------------\r
3\r
d7fbaba9
O
4.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
5 :target: https://pypi.python.org/pypi/rainbowstream\r
3216f3f4 6\r
d7fbaba9
O
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
091aaddc 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \r
687567eb 14can run on Python 2.7.x and 3.x .\r
091aaddc 15\r
3108149e 16\r
456019d6 17Showcase\r
3108149e 18----------\r
b84845b9 19Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
456019d6 20\r
11302396 21Screenshot: (click to see)\r
3216f3f4 22\r
11302396
O
23.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
24 :alt: all\r
997c0570 25\r
3108149e 26Install\r
27-------\r
28\r
45e6bb0d
O
29The quick way\r
30^^^^^^^^^^^^^\r
31\r
8e004f8d 32You will need Python and pip (2.7.x or 3.x).\r
3108149e 33\r
34.. code:: bash\r
35\r
fd9cd791 36 sudo pip install rainbowstream\r
8e004f8d 37 # Python 3 users: sudo pip3 install rainbowstream\r
b84845b9 38\r
b84845b9 39\r
45e6bb0d
O
40The recommended way\r
41^^^^^^^^^^^^^^^^^^^\r
42\r
43Use `virtualenv`_\r
fd9cd791
O
44\r
45.. code:: bash\r
46\r
b84845b9 47 virtualenv venv\r
45e6bb0d
O
48 # Python 3 users : use -p to specify your Python 3 localtion as below\r
49 # virtualenv -p /usr/bin/python3 venv\r
50 source venv/bin/activate\r
3108149e 51 pip install rainbowstream\r
52\r
45e6bb0d 53\r
3108149e 54Usage\r
55-----\r
56\r
57The stream\r
58^^^^^^^^^^\r
59\r
60Just type\r
61\r
62.. code:: bash\r
63\r
9f37426f 64 rainbowstream\r
3108149e 65\r
66and see your stream.\r
67\r
3216f3f4
O
68I shipped a feature which can display **tweet's images directly on terminal**.\r
69You can try it with:\r
4373c17c
O
70\r
71.. code:: bash\r
72\r
9f37426f 73 rainbowstream -iot # Or rainbowstream --image-on-term\r
4373c17c 74\r
89d0f21f
O
75You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
76to enable above feature (see `config management`_ section).\r
77\r
3108149e 78In the first time you will be asked for authorization of Rainbow Stream\r
79app at Twitter. Just click the “Authorize access” button and paste PIN\r
3216f3f4 80number to the terminal, the rainbow will start.\r
3108149e 81\r
82The interactive mode\r
c1a3d5e5 83--------------------\r
3108149e 84\r
85While your personal stream is continued, you are also ready to tweet,\r
86search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 87the Enter key to see the help.\r
3108149e 88\r
89Input is in interactive mode. It means that you can use arrow key to\r
90move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 91suggestion. Input history from previous run is available as well.\r
3108149e 92\r
b913cd75 93Available commands are listed in `Read The Docs`_.\r
3108149e 94\r
b913cd75
O
95Theme customization\r
96------------------------\r
97\r
06302419 98Rainbow Stream is shipped with some default themes.\r
b913cd75
O
99You can either change theme by ``theme`` command or create your favorite one.\r
100\r
547283bf 101Theme’s screenshot:\r
19d6c002 102\r
06302419
O
103- Monokai\r
104\r
547283bf
O
105.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
106 :alt: monokai\r
19d6c002 107\r
06302419
O
108- Solarized\r
109\r
547283bf
O
110.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
111 :alt: solarized\r
112\r
98258022
O
113- Tomorrow Night\r
114\r
115.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
116 :alt: tomorrownight\r
117\r
118- Larapaste\r
119\r
120.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
121 :alt: larapaste\r
122\r
123\r
b913cd75 124For detaile information, see `theme usage and customization`_.\r
3108149e 125\r
050c4214 126Bug and feature requests\r
36e1924e 127------------------------\r
3108149e 128\r
b84845b9 129Found a bug or a feature request ?\r
3216f3f4 130Please `create an issue`_ or contact me at `@dtvd88`_\r
3108149e 131\r
2d341029
O
132Development\r
133-----------\r
134\r
135If you want to build a runnable version yourself, follow these simple\r
136steps\r
137\r
138- `Create your own Twitter Application`_\r
139- Get your Twitter application’s API key and secret\r
a80d4179 140- Fork this repo and clone in your system.\r
b145ada0 141- Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
2d341029
O
142 following content\r
143\r
144 .. code:: python\r
145\r
146 # Consumer information\r
147 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
148 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
149\r
150- Use pip to install in local\r
151\r
152 .. code:: bash\r
153\r
a80d4179 154 # cd to directory which contains setup.py (cloned directory)\r
2d341029
O
155 virtualenv venv # Python3 users: use -p to specify python3\r
156 source venv/bin/activate\r
157 pip install -e .\r
a80d4179
O
158 which rainbowstream # /this-directory/venv/bin/rainbowstream\r
159 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
160 # Remove ~/.rainbow_oauth if exists\r
2d341029
O
161 rainbowstream # local version of rainbowstream\r
162\r
163\r
050c4214 164Contributing\r
36e1924e 165------------\r
050c4214
O
166I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
167You will be listed as contributor.\r
168\r
3108149e 169License\r
170-------\r
171\r
172Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
173details\r
174\r
175\r
176.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 177.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3108149e 178.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
3216f3f4 179.. _@dtvd88: https://twitter.com/dtvd88\r
050c4214
O
180.. _fork: https://github.com/DTVD/rainbowstream/fork\r
181.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
670e8049 182.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
b52327dc 183.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
b913cd75 184.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
2d341029 185.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
b145ada0 186.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
45e6bb0d 187.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
89d0f21f 188.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r