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