Commit | Line | Data |
---|---|---|
3108149e | 1 | Rainbow Stream\r |
2 | --------------\r | |
3 | \r | |
3216f3f4 O |
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 | |
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 | |
3216f3f4 | 13 | This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r |
3108149e | 14 | \r |
456019d6 | 15 | Showcase\r |
3108149e | 16 | ----------\r |
b84845b9 | 17 | Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r |
456019d6 | 18 | \r |
3216f3f4 | 19 | \r |
3108149e | 20 | Install\r |
21 | -------\r | |
22 | \r | |
45e6bb0d O |
23 | The quick way\r |
24 | ^^^^^^^^^^^^^\r | |
25 | \r | |
8e004f8d | 26 | You will need Python and pip (2.7.x or 3.x).\r |
3108149e | 27 | \r |
28 | .. code:: bash\r | |
29 | \r | |
fd9cd791 | 30 | sudo pip install rainbowstream\r |
8e004f8d | 31 | # Python 3 users: sudo pip3 install rainbowstream\r |
b84845b9 | 32 | \r |
45e6bb0d O |
33 | \r |
34 | The recommended way\r | |
35 | ^^^^^^^^^^^^^^^^^^^\r | |
36 | \r | |
37 | Use `virtualenv`_\r | |
fd9cd791 O |
38 | \r |
39 | .. code:: bash\r | |
40 | \r | |
b84845b9 | 41 | virtualenv venv\r |
45e6bb0d O |
42 | # Python 3 users : use -p to specify your Python 3 localtion as below\r |
43 | # virtualenv -p /usr/bin/python3 venv\r | |
44 | source venv/bin/activate\r | |
3108149e | 45 | pip install rainbowstream\r |
46 | \r | |
45e6bb0d | 47 | \r |
3108149e | 48 | Usage\r |
49 | -----\r | |
50 | \r | |
51 | The stream\r | |
52 | ^^^^^^^^^^\r | |
53 | \r | |
54 | Just type\r | |
55 | \r | |
56 | .. code:: bash\r | |
57 | \r | |
9f37426f | 58 | rainbowstream\r |
3108149e | 59 | \r |
60 | and see your stream.\r | |
61 | \r | |
3216f3f4 O |
62 | I shipped a feature which can display **tweet's images directly on terminal**.\r |
63 | You can try it with:\r | |
4373c17c O |
64 | \r |
65 | .. code:: bash\r | |
66 | \r | |
9f37426f | 67 | rainbowstream -iot # Or rainbowstream --image-on-term\r |
4373c17c | 68 | \r |
3108149e | 69 | In the first time you will be asked for authorization of Rainbow Stream\r |
70 | app at Twitter. Just click the “Authorize access” button and paste PIN\r | |
3216f3f4 | 71 | number to the terminal, the rainbow will start.\r |
3108149e | 72 | \r |
73 | The interactive mode\r | |
c1a3d5e5 | 74 | --------------------\r |
3108149e | 75 | \r |
76 | While your personal stream is continued, you are also ready to tweet,\r | |
77 | search, reply, retweet… directly from console. Simply type “h” and hit\r | |
f5677fb1 | 78 | the Enter key to see the help.\r |
3108149e | 79 | \r |
80 | Input is in interactive mode. It means that you can use arrow key to\r | |
81 | move up and down history, tab-autocomplete or 2 tab to view available\r | |
f5677fb1 | 82 | suggestion. Input history from previous run is available as well.\r |
3108149e | 83 | \r |
b913cd75 | 84 | Available commands are listed in `Read The Docs`_.\r |
3108149e | 85 | \r |
b913cd75 O |
86 | Theme customization\r |
87 | ------------------------\r | |
88 | \r | |
06302419 | 89 | Rainbow Stream is shipped with some default themes.\r |
b913cd75 O |
90 | You can either change theme by ``theme`` command or create your favorite one.\r |
91 | \r | |
547283bf | 92 | Theme’s screenshot:\r |
19d6c002 | 93 | \r |
06302419 O |
94 | - Monokai\r |
95 | \r | |
547283bf O |
96 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r |
97 | :alt: monokai\r | |
19d6c002 | 98 | \r |
06302419 O |
99 | - Solarized\r |
100 | \r | |
547283bf O |
101 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r |
102 | :alt: solarized\r | |
103 | \r | |
98258022 O |
104 | - Tomorrow Night\r |
105 | \r | |
106 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r | |
107 | :alt: tomorrownight\r | |
108 | \r | |
109 | - Larapaste\r | |
110 | \r | |
111 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r | |
112 | :alt: larapaste\r | |
113 | \r | |
114 | \r | |
b913cd75 | 115 | For detaile information, see `theme usage and customization`_.\r |
3108149e | 116 | \r |
050c4214 | 117 | Bug and feature requests\r |
36e1924e | 118 | ------------------------\r |
3108149e | 119 | \r |
b84845b9 | 120 | Found a bug or a feature request ?\r |
3216f3f4 | 121 | Please `create an issue`_ or contact me at `@dtvd88`_\r |
3108149e | 122 | \r |
050c4214 | 123 | Contributing\r |
36e1924e | 124 | ------------\r |
050c4214 O |
125 | I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r |
126 | You will be listed as contributor.\r | |
127 | \r | |
3108149e | 128 | License\r |
129 | -------\r | |
130 | \r | |
131 | Rainbow Stream are released under an MIT License. See LICENSE.txt for\r | |
132 | details\r | |
133 | \r | |
134 | \r | |
135 | .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r | |
bade45d4 | 136 | .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r |
3108149e | 137 | .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r |
3216f3f4 | 138 | .. _@dtvd88: https://twitter.com/dtvd88\r |
050c4214 O |
139 | .. _fork: https://github.com/DTVD/rainbowstream/fork\r |
140 | .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r | |
670e8049 | 141 | .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r |
b52327dc | 142 | .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r |
b913cd75 | 143 | .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r |
45e6bb0d | 144 | .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r |