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