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