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