Merge pull request #162 from Tak-MK/patch-1
[rainbowstream.git] / README.rst
1 Rainbow Stream\r
2 --------------\r
3 \r
4 .. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square\r
5    :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt\r
6 \r
7 .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square\r
8    :target: https://pypi.python.org/pypi/rainbowstream\r
9 \r
10 Terminal-based Twitter Client. Realtime tweetstream, compose, search,\r
11 favorite … and much more fun directly from terminal.\r
12 \r
13 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
14 can run on Python 2.7.x and 3.x .\r
15 \r
16 Home page : http://www.rainbowstream.org/\r
17 \r
18 Source code : https://github.com/DTVD/rainbowstream\r
19 \r
20 Showcase\r
21 --------\r
22 \r
23 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
24    :alt: gif\r
25 \r
26 Install\r
27 -------\r
28 \r
29 The quick way\r
30 ^^^^^^^^^^^^^\r
31 \r
32 You will need Python and pip (2.7.x or 3.x).\r
33 \r
34 .. code:: bash\r
35 \r
36     sudo pip install rainbowstream\r
37     # Python 3 users: sudo pip3 install rainbowstream\r
38 \r
39 \r
40 The recommended way\r
41 ^^^^^^^^^^^^^^^^^^^\r
42 \r
43 Use `virtualenv`_\r
44 \r
45 .. code:: bash\r
46 \r
47     virtualenv venv\r
48     # Python 3 users : use -p to specify your Python 3 location as below\r
49     # virtualenv -p /usr/bin/python3 venv\r
50     source venv/bin/activate\r
51     pip install rainbowstream\r
52 \r
53 Troubleshooting\r
54 ^^^^^^^^^^^^^^^\r
55 \r
56 If you use Linux, you might need to install some packages if you haven't already.\r
57 For debian-based distros, these can be installed with\r
58 \r
59 .. code:: bash\r
60 \r
61     sudo apt-get install python-dev libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
62 \r
63 For CentOS:\r
64 \r
65 .. code:: bash\r
66 \r
67     sudo yum install python-devel libjpeg-devel\r
68 \r
69 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
70 the ``Pillow`` package installation - a dependency of this app.\r
71 If you are in this case, I recommend taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you.\r
72 \r
73 .. code:: bash\r
74 \r
75     export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
76 \r
77 If installation in *the quick way* doesn't work:\r
78 \r
79 -  ``sudo pip uninstall rainbowstream``\r
80 -  use the *virtualenv way* above\r
81 -  `create an issue`_ and provide:\r
82 \r
83   + Your OS\r
84   + Your Python version\r
85 \r
86 Usage\r
87 -----\r
88 \r
89 The stream\r
90 ^^^^^^^^^^\r
91 \r
92 Just type\r
93 \r
94 .. code:: bash\r
95 \r
96     rainbowstream\r
97 \r
98 and see your stream.\r
99 \r
100 I shipped a feature which can display **tweet's images directly on terminal**.\r
101 You can try it with:\r
102 \r
103 .. code:: bash\r
104 \r
105     rainbowstream -iot # Or rainbowstream --image-on-term\r
106 \r
107 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
108 to enable above feature,\r
109 change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)\r
110 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
111 (see `config management`_ section).\r
112 \r
113 In the first time you will be asked for authorization of Rainbow Stream\r
114 app at Twitter. Just click the “Authorize access” button and paste PIN\r
115 number to the terminal, the rainbow will start.\r
116 \r
117 You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are\r
118 provided as follows:\r
119 \r
120 .. code:: bash\r
121 \r
122     rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP\r
123     # or using the short form:\r
124     rainbowstream -ph localhost -pp 1337 -pt HTTP\r
125 \r
126 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default\r
127 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.\r
128 \r
129 The interactive mode\r
130 ^^^^^^^^^^^^^^^^^^^^\r
131 \r
132 While your personal stream is continued, you are also ready to tweet,\r
133 search, reply, retweet… directly from console. Simply type “h” and hit\r
134 the Enter key to see the help.\r
135 \r
136 Input is in interactive mode. It means that you can use arrow key to\r
137 move up and down history, tab-autocomplete or 2 tab to view available\r
138 suggestion. Input history from previous run is available as well.\r
139 \r
140 Available commands are listed in `Read The Docs`_.\r
141 \r
142 Theme customization\r
143 ^^^^^^^^^^^^^^^^^^^\r
144 \r
145 Rainbow Stream is shipped with some default themes.\r
146 You can either change theme by ``theme`` command or create your favorite one.\r
147 \r
148 Theme’s screenshot:\r
149 \r
150 - Monokai\r
151 \r
152 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
153    :alt: monokai\r
154 \r
155 - Solarized\r
156 \r
157 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
158    :alt: solarized\r
159 \r
160 - Tomorrow Night\r
161 \r
162 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
163    :alt: tomorrownight\r
164 \r
165 - Larapaste\r
166 \r
167 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
168    :alt: larapaste\r
169 \r
170 For detail information, see `theme usage and customization`_.\r
171 \r
172 \r
173 Bug and feature requests\r
174 ------------------------\r
175 \r
176 Found a bug or a feature request ?\r
177 Please `create an issue`_ or contact me at `@dtvd88`_\r
178 \r
179 Development\r
180 -----------\r
181 \r
182 If you want to build a runnable version yourself, follow these simple\r
183 steps\r
184 \r
185 -  `Create your own Twitter Application`_\r
186 -  Get your Twitter application’s API key and secret\r
187 -  Fork this repo and clone in your system.\r
188 -  Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
189    following content\r
190 \r
191    .. code:: python\r
192 \r
193        # Consumer information\r
194        CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
195        CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
196 \r
197 -  Use pip to install in local\r
198 \r
199    .. code:: bash\r
200 \r
201        # cd to directory which contains setup.py (cloned directory)\r
202        virtualenv venv # Python3 users: use -p to specify python3\r
203        source venv/bin/activate\r
204        pip install -e .\r
205        which rainbowstream # /this-directory/venv/bin/rainbowstream\r
206        # Remove ~/.rainbow_oauth if exists\r
207        rainbowstream # local version of rainbowstream\r
208 \r
209 \r
210 Contributing\r
211 ------------\r
212 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
213 You will be listed as contributor.\r
214 \r
215 License\r
216 -------\r
217 \r
218 Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
219 details\r
220 \r
221 \r
222 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
223 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
224 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
225 .. _@dtvd88: https://twitter.com/dtvd88\r
226 .. _fork: https://github.com/DTVD/rainbowstream/fork\r
227 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
228 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
229 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
230 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
231 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
232 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
233 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
234 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
235 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
236 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r