Commit | Line | Data |
---|---|---|
3108149e | 1 | Rainbow Stream\r |
2 | --------------\r | |
3 | \r | |
d7fbaba9 O |
4 | .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r |
5 | :target: https://pypi.python.org/pypi/rainbowstream\r | |
3216f3f4 | 6 | \r |
d7fbaba9 O |
7 | .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r |
8 | :target: https://pypi.python.org/pypi/rainbowstream\r | |
c96321cc | 9 | \r |
3108149e | 10 | Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r |
11 | favorite … and much more fun directly from terminal.\r | |
12 | \r | |
091aaddc | 13 | This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \r |
687567eb | 14 | can run on Python 2.7.x and 3.x .\r |
091aaddc | 15 | \r |
3108149e | 16 | \r |
456019d6 | 17 | Showcase\r |
b13c6a0d | 18 | --------\r |
456019d6 | 19 | \r |
bd48f980 | 20 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r |
99087831 | 21 | :alt: gif\r |
997c0570 | 22 | \r |
3108149e | 23 | Install\r |
24 | -------\r | |
25 | \r | |
45e6bb0d O |
26 | The quick way\r |
27 | ^^^^^^^^^^^^^\r | |
28 | \r | |
8e004f8d | 29 | You will need Python and pip (2.7.x or 3.x).\r |
3108149e | 30 | \r |
31 | .. code:: bash\r | |
32 | \r | |
fd9cd791 | 33 | sudo pip install rainbowstream\r |
8e004f8d | 34 | # Python 3 users: sudo pip3 install rainbowstream\r |
b84845b9 | 35 | \r |
b84845b9 | 36 | \r |
45e6bb0d O |
37 | The recommended way\r |
38 | ^^^^^^^^^^^^^^^^^^^\r | |
39 | \r | |
40 | Use `virtualenv`_\r | |
fd9cd791 O |
41 | \r |
42 | .. code:: bash\r | |
43 | \r | |
b84845b9 | 44 | virtualenv venv\r |
45e6bb0d O |
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 | |
3108149e | 48 | pip install rainbowstream\r |
49 | \r | |
45e6bb0d | 50 | \r |
3108149e | 51 | Usage\r |
52 | -----\r | |
53 | \r | |
54 | The stream\r | |
55 | ^^^^^^^^^^\r | |
56 | \r | |
57 | Just type\r | |
58 | \r | |
59 | .. code:: bash\r | |
60 | \r | |
9f37426f | 61 | rainbowstream\r |
3108149e | 62 | \r |
63 | and see your stream.\r | |
64 | \r | |
3216f3f4 O |
65 | I shipped a feature which can display **tweet's images directly on terminal**.\r |
66 | You can try it with:\r | |
4373c17c O |
67 | \r |
68 | .. code:: bash\r | |
69 | \r | |
9f37426f | 70 | rainbowstream -iot # Or rainbowstream --image-on-term\r |
4373c17c | 71 | \r |
89d0f21f O |
72 | You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r |
73 | to enable above feature (see `config management`_ section).\r | |
74 | \r | |
3108149e | 75 | In the first time you will be asked for authorization of Rainbow Stream\r |
76 | app at Twitter. Just click the “Authorize access” button and paste PIN\r | |
3216f3f4 | 77 | number to the terminal, the rainbow will start.\r |
3108149e | 78 | \r |
79 | The interactive mode\r | |
c1a3d5e5 | 80 | --------------------\r |
3108149e | 81 | \r |
82 | While your personal stream is continued, you are also ready to tweet,\r | |
83 | search, reply, retweet… directly from console. Simply type “h” and hit\r | |
f5677fb1 | 84 | the Enter key to see the help.\r |
3108149e | 85 | \r |
86 | Input is in interactive mode. It means that you can use arrow key to\r | |
87 | move up and down history, tab-autocomplete or 2 tab to view available\r | |
f5677fb1 | 88 | suggestion. Input history from previous run is available as well.\r |
3108149e | 89 | \r |
b913cd75 | 90 | Available commands are listed in `Read The Docs`_.\r |
3108149e | 91 | \r |
b913cd75 | 92 | Theme customization\r |
b13c6a0d | 93 | -------------------\r |
b913cd75 | 94 | \r |
06302419 | 95 | Rainbow Stream is shipped with some default themes.\r |
b913cd75 O |
96 | You can either change theme by ``theme`` command or create your favorite one.\r |
97 | \r | |
547283bf | 98 | Theme’s screenshot:\r |
19d6c002 | 99 | \r |
06302419 O |
100 | - Monokai\r |
101 | \r | |
547283bf O |
102 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r |
103 | :alt: monokai\r | |
19d6c002 | 104 | \r |
06302419 O |
105 | - Solarized\r |
106 | \r | |
547283bf O |
107 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r |
108 | :alt: solarized\r | |
109 | \r | |
98258022 O |
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 | |
b913cd75 | 121 | For detaile information, see `theme usage and customization`_.\r |
3108149e | 122 | \r |
050c4214 | 123 | Bug and feature requests\r |
36e1924e | 124 | ------------------------\r |
3108149e | 125 | \r |
b84845b9 | 126 | Found a bug or a feature request ?\r |
3216f3f4 | 127 | Please `create an issue`_ or contact me at `@dtvd88`_\r |
3108149e | 128 | \r |
2d341029 O |
129 | Development\r |
130 | -----------\r | |
131 | \r | |
132 | If you want to build a runnable version yourself, follow these simple\r | |
133 | steps\r | |
134 | \r | |
135 | - `Create your own Twitter Application`_\r | |
136 | - Get your Twitter application’s API key and secret\r | |
a80d4179 | 137 | - Fork this repo and clone in your system.\r |
b145ada0 | 138 | - Create a file ``consumer.py`` in `rainbowstream`_ folder with\r |
2d341029 O |
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 | |
a80d4179 | 151 | # cd to directory which contains setup.py (cloned directory)\r |
2d341029 O |
152 | virtualenv venv # Python3 users: use -p to specify python3\r |
153 | source venv/bin/activate\r | |
154 | pip install -e .\r | |
a80d4179 O |
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 | |
2d341029 O |
158 | rainbowstream # local version of rainbowstream\r |
159 | \r | |
160 | \r | |
050c4214 | 161 | Contributing\r |
36e1924e | 162 | ------------\r |
050c4214 O |
163 | I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r |
164 | You will be listed as contributor.\r | |
165 | \r | |
3108149e | 166 | License\r |
167 | -------\r | |
168 | \r | |
169 | Rainbow Stream are released under an MIT License. See LICENSE.txt for\r | |
170 | details\r | |
171 | \r | |
172 | \r | |
173 | .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r | |
bade45d4 | 174 | .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r |
3108149e | 175 | .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r |
3216f3f4 | 176 | .. _@dtvd88: https://twitter.com/dtvd88\r |
050c4214 O |
177 | .. _fork: https://github.com/DTVD/rainbowstream/fork\r |
178 | .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r | |
670e8049 | 179 | .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r |
b52327dc | 180 | .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r |
b913cd75 | 181 | .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r |
2d341029 | 182 | .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r |
b145ada0 | 183 | .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r |
45e6bb0d | 184 | .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r |
89d0f21f | 185 | .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r |