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