add share command and show Twitter client name
[rainbowstream.git] / README.rst
... / ...
CommitLineData
1Rainbow 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
10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
14can run on Python 2.7.x and 3.x .\r
15\r
16\r
17Showcase\r
18--------\r
19\r
20.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
21 :alt: gif\r
22\r
23Install\r
24-------\r
25\r
26The quick way\r
27^^^^^^^^^^^^^\r
28\r
29You 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
37The recommended way\r
38^^^^^^^^^^^^^^^^^^^\r
39\r
40Use `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
50Troubleshooting\r
51^^^^^^^^^^^^^^^\r
52\r
53If you use Linux, you might need to install some packages if you haven't already.\r
54For 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
60Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
61the ``Pillow`` package installation - a dependency of this app.\r
62If 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
68If 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
77Usage\r
78-----\r
79\r
80The stream\r
81^^^^^^^^^^\r
82\r
83Just type\r
84\r
85.. code:: bash\r
86\r
87 rainbowstream\r
88\r
89and see your stream.\r
90\r
91I shipped a feature which can display **tweet's images directly on terminal**.\r
92You can try it with:\r
93\r
94.. code:: bash\r
95\r
96 rainbowstream -iot # Or rainbowstream --image-on-term\r
97\r
98You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
99to enable above feature,\r
100change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)\r
101or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
102(see `config management`_ section).\r
103\r
104In the first time you will be asked for authorization of Rainbow Stream\r
105app at Twitter. Just click the “Authorize access” button and paste PIN\r
106number to the terminal, the rainbow will start.\r
107\r
108The interactive mode\r
109^^^^^^^^^^^^^^^^^^^^\r
110\r
111While your personal stream is continued, you are also ready to tweet,\r
112search, reply, retweet… directly from console. Simply type “h” and hit\r
113the Enter key to see the help.\r
114\r
115Input is in interactive mode. It means that you can use arrow key to\r
116move up and down history, tab-autocomplete or 2 tab to view available\r
117suggestion. Input history from previous run is available as well.\r
118\r
119Available commands are listed in `Read The Docs`_.\r
120\r
121Theme customization\r
122^^^^^^^^^^^^^^^^^^^\r
123\r
124Rainbow Stream is shipped with some default themes.\r
125You can either change theme by ``theme`` command or create your favorite one.\r
126\r
127Theme’s screenshot:\r
128\r
129- Monokai\r
130\r
131.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
132 :alt: monokai\r
133\r
134- Solarized\r
135\r
136.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
137 :alt: solarized\r
138\r
139- Tomorrow Night\r
140\r
141.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
142 :alt: tomorrownight\r
143\r
144- Larapaste\r
145\r
146.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
147 :alt: larapaste\r
148\r
149For detaile information, see `theme usage and customization`_.\r
150\r
151\r
152Bug and feature requests\r
153------------------------\r
154\r
155Found a bug or a feature request ?\r
156Please `create an issue`_ or contact me at `@dtvd88`_\r
157\r
158Development\r
159-----------\r
160\r
161If you want to build a runnable version yourself, follow these simple\r
162steps\r
163\r
164- `Create your own Twitter Application`_\r
165- Get your Twitter application’s API key and secret\r
166- Fork this repo and clone in your system.\r
167- Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
168 following content\r
169\r
170 .. code:: python\r
171\r
172 # Consumer information\r
173 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
174 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
175\r
176- Use pip to install in local\r
177\r
178 .. code:: bash\r
179\r
180 # cd to directory which contains setup.py (cloned directory)\r
181 virtualenv venv # Python3 users: use -p to specify python3\r
182 source venv/bin/activate\r
183 pip install -e .\r
184 which rainbowstream # /this-directory/venv/bin/rainbowstream\r
185 # Remove ~/.rainbow_oauth if exists\r
186 rainbowstream # local version of rainbowstream\r
187\r
188\r
189Contributing\r
190------------\r
191I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
192You will be listed as contributor.\r
193\r
194License\r
195-------\r
196\r
197Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
198details\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