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