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