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