Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 173 lines (114 sloc) 3.794 kb
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
1 ===========
2 convoread
3 ===========
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
4
0858ead @vlasovskikh m
vlasovskikh authored
5 Command-line tool for `Convore`_.
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
6
024fd42 @vlasovskikh version 0.5
vlasovskikh authored
7 Latest version: 0.5, 2011-02-18.
118f205 @vlasovskikh version 0.4
vlasovskikh authored
8
5a95ff3 @piranha add link to discussion on convore to README
piranha authored
9 .. _Convore: https://convore.com/
10
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
11
12 Description
13 -----------
14
024fd42 @vlasovskikh version 0.5
vlasovskikh authored
15 ``convoread`` is a tool for sending and receiving Convore messages from the
16 command line.
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
17
024fd42 @vlasovskikh version 0.5
vlasovskikh authored
18 Some of it's features include:
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
19
024fd42 @vlasovskikh version 0.5
vlasovskikh authored
20 - Interactive console chat interface
21 - Desktop notifications [*]_
22 - Convenient topic switching
23 - Unread topics by group
24 - Recent topics and messages
25
26 .. [*] At this moment desktop notifications work only for Ubuntu and similar
27 systems with ``libnotify`` installed.
28
29 Future versions of ``convoread`` will allow creating topics, managing
30 notifications, etc.
31
32 See a `discussion`_ on Convore for ``convoread`` announcements and support.
5a95ff3 @piranha add link to discussion on convore to README
piranha authored
33
34 .. _discussion: https://convore.com/feedback/convoread-simple-console-client-for-convore/
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
35
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
36
024fd42 @vlasovskikh version 0.5
vlasovskikh authored
37 What's New in 0.5
38 -----------------
39
40 - More readable chat logs with topic change messages
41 - Command ``/ts`` displays topics by group, including unread messages count
42 - Command ``/t`` selects a topic *and* lists recent messages
43 - Removed command ``/ls``
44 - Recent topics are updated dynamically based on incoming messages
45 - Input and output characters don't interfere anymore
46 - Timestamps in the local timezone
47 - Various bug fixes
48
49 See also the `changelog`_.
50
51 .. _changelog: https://github.com/foobarbuzz/convoread/blob/master/CHANGES.rst
52
53
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
54 Usage
55 -----
56
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
57 Run the program::
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
58
67fd2f4 @piranha fix setup.py and update README
piranha authored
59 $ convoread
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
60 welcome to convoread! type /help for more info
61 >
62
63 You are now in ``convoread`` shell. You can just watch your live stream
64 indefinitely::
65
541b797 @vlasovskikh updated README
vlasovskikh authored
66 *** topic mygroup/1234: Some tests
67 13:06 <user1> hello
68 13:21 <user2> convoread works
69 13:22 <user1> @user2 indeed!
70
71 *** topic othergroup/5678: Another topic
72 14:07 <user3> convoread is nice
127660b @vlasovskikh synchronized input and live output, use threads instead of processes
vlasovskikh authored
73 >
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
74
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
75 You can also list recent topics and send messages::
76
7c87098 @vlasovskikh changed topic commands: /t, /ts, display unread messages count
vlasovskikh authored
77 > /ts
7e12767 @vlasovskikh /ts: unread topics by group, /ts name: topics in group <name>
vlasovskikh authored
78 python:
79 4393 3 pyquery - a jquery-like library for python
80 4383 1 Fate of PySide
81 vim:
82 3012 1 Configuring Vim for Python
83 mercurial:
84 2412 1 Extensions I just can live without
85 emacs:
86 feedback:
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
87 > /t 3012
541b797 @vlasovskikh updated README
vlasovskikh authored
88
89 *** topic vim/3012: Configuring Vim for Python
7c87098 @vlasovskikh changed topic commands: /t, /ts, display unread messages count
vlasovskikh authored
90 12:46 <user3> i configured it in .vimrc
91 12:47 <user3> and i use this feature every day
92 > hello vim community!
541b797 @vlasovskikh updated README
vlasovskikh authored
93 13:25 <user3> welcome
94 > so, vim or emacs? :)
95 13:26 <user3> vim!
127660b @vlasovskikh synchronized input and live output, use threads instead of processes
vlasovskikh authored
96 >
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
97
98 Press ``/q`` to exit::
99
100 > /q
101 quit
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
102
64c9ae4 @vlasovskikh README update
vlasovskikh authored
103 You can also enable desktop notifications for Ubuntu and similar systems that
024fd42 @vlasovskikh version 0.5
vlasovskikh authored
104 support ``libnotify``::
fc280ce @vlasovskikh docs about --notify
vlasovskikh authored
105
106 $ convoread --notify
107
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
108 For more info on usage type::
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
109
67fd2f4 @piranha fix setup.py and update README
piranha authored
110 $ convoread --help
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
111
112
67fd2f4 @piranha fix setup.py and update README
piranha authored
113 Installation
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
114 ------------
115
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
116 You can install (or update) it from PyPI::
64c9ae4 @vlasovskikh README update
vlasovskikh authored
117
9aeae99 @vlasovskikh updated usage in README
vlasovskikh authored
118 $ pip install -U convoread
67fd2f4 @piranha fix setup.py and update README
piranha authored
119
120 Or you can clone it from GitHub and then use ``develop`` command to get it
64c9ae4 @vlasovskikh README update
vlasovskikh authored
121 symlinked to your system-wide ``$PATH``::
67fd2f4 @piranha fix setup.py and update README
piranha authored
122
123 $ git clone https://github.com/foobarbuzz/convoread.git
124 $ cd convoread
64c9ae4 @vlasovskikh README update
vlasovskikh authored
125 $ python setup.py develop
126
127 Or symlink it to your home directory only::
67fd2f4 @piranha fix setup.py and update README
piranha authored
128
64c9ae4 @vlasovskikh README update
vlasovskikh authored
129 $ python setup.py develop --user
67fd2f4 @piranha fix setup.py and update README
piranha authored
130
64c9ae4 @vlasovskikh README update
vlasovskikh authored
131 Check that ``~/.local/bin`` is in your ``$PATH``.
67fd2f4 @piranha fix setup.py and update README
piranha authored
132
133
134 Requirements
135 ~~~~~~~~~~~~
136
88a7bc4 @piranha remove this unicode char, setuptools are dumb
piranha authored
137 * Python >= 2.6 (Python 3 has some issues yet)
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
138
e579909 @vlasovskikh added PIL to optional requirements
vlasovskikh authored
139 Optional:
64c9ae4 @vlasovskikh README update
vlasovskikh authored
140
127660b @vlasovskikh synchronized input and live output, use threads instead of processes
vlasovskikh authored
141 * libnotify for desktop notifications
e579909 @vlasovskikh added PIL to optional requirements
vlasovskikh authored
142 * PIL (Python Imaging Library) for avatars in notifications
64c9ae4 @vlasovskikh README update
vlasovskikh authored
143
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
144
145 Configuration
146 -------------
147
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
148 ``convoread`` uses login and password, supplied in ``~/.netrc`` file in a standard
149 format. If you're wondering, what is the format of ``.netrc``::
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
150
151 machine convore.com
152 login <your-username>
153 password <your-password>
154
155
156 Authors
157 -------
158
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
159 * `Andrey Vlasovskikh`_
160 * `Alexander Solovyov`_
8f78ea6 @vlasovskikh m
vlasovskikh authored
161 * `Mikhail Krivushin`_
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
162 * Timofei Perevezentsev
163
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
164 .. _Andrey Vlasovskikh: http://pirx.ru/
165 .. _Alexander Solovyov: http://piranha.org.ua/
8f78ea6 @vlasovskikh m
vlasovskikh authored
166 .. _Mikhail Krivushin: http://deepwalker.blogspot.com/
014ebd1 @piranha md is dumb and is not used by PyPI, no reason to move to md
piranha authored
167
e9cfa0e @vlasovskikh updated README
vlasovskikh authored
168
169 License
170 -------
171
172 MIT License.
Something went wrong with that request. Please try again.