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