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