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