Prepare release 0.3.0.

Author: worblehat

doc/source/conf.py

@@ -56,7 +56,7 @@
 # The short X.Y version.
 version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = '0.2.0'
+release = '0.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/history.rst

@@ -1,25 +1,27 @@
 Changelog
 =========
 
-v0.3.0 (2015-12-XX)
+v0.3.0 (2015-12-09)
 -------------------
 
-**Attention**: This release contains some backward-incompatible changes (marked with (!) below).
+**Attention**: This release contains some backward-incompatible changes (marked with **(!)** below).
 
 * ChannelInfo-class with information about a channel like current topic and members
 
   * access via IRCClient.channel_info
 
 * changing the nick name of the client
 * handle nick changes
-* introduced handle_own_(kick|got_op|lost_op|got_voice|lost_voice)-methods
+* handle quits
+* handle changes to operator- and voice-status
+* introduced handle_own_kick()-method
 
-  * (!) when the bot gets kicked, this can only be handled in
+  * **(!)** when the bot gets kicked, this can only be handled in
     handle_own_kick() instead of handle_kick() now
 
 * optional delay for channel messages
 * the delay of a Task can be changed now
-* IRCClient.channels now returns an iterator instead of a tuple
+* **(!)** IRCClient.channels now returns an iterator instead of a tuple
 
 v0.2.2 (2015-04-11)
 -------------------

doc/source/index.rst

@@ -31,6 +31,8 @@ The source code repository is hosted at `Github <https://github.com/worblehat/Fr
 Wishlist
 ++++++++
 
+* More commands (e.g. KICK, TOPIC,...)
+* Querying user modes for other users
 * Advanced logging of chat histories
 * Allow multiple IRCClient instances and/or to re-run a terminated IRCClient
 * SSL-support

fredirc/client.py

@@ -48,6 +48,13 @@ class IRCClient(asyncio.Protocol):
     :py:meth:`.join` but only after
     :py:meth:`handle_own_join()<.IRCHandler.handle_own_join>` was called.
 
+    Channel and nick name arguments to methods that send a command to the server
+    are case insensitive, except for methods that change the clients nick.
+    Channel names returned by the server (e.g. in IRCClient's
+    :py:attr:`.channels`-property)
+    are usually lower case while nick names are the case they were registered by
+    it's user.
+
     Args:
         handler (:py:class:`IRCHandler<fredirc.IRCHandler>`): \
             handler that handles events from this client
@@ -145,7 +152,7 @@ def reconnect(self, delay=0.0):
             return
         self._reconnect = True
         time.sleep(delay)
-        asyncio.get_event_loop().stop() # TODO use terminate() here?
+        asyncio.get_event_loop().stop()  # TODO use terminate() here?
 
     def enable_logging(self, enable):
         """ Enable or disable logging.
@@ -483,7 +490,7 @@ def data_received(self, data):
             #    then loop 'while self._buffer', look for terminator and remove
             #    the message.
             # 2. Make buffer a byte string, split lines to list, iterate list,
-            #    clear buffer. Con: While handling messageis in loop, buffer
+            #    clear buffer. Con: While handling messages in loop, buffer
             #    stays the same (empty or with all messages that were received)
             # Con of buffer byte string: more difficult to debug
             #
@@ -507,6 +514,8 @@ def _get_channel_info(self):
     channel_info = property(_get_channel_info)
     """ Get information about channels.
 
+    To get all channel names use :py:attr:`.channels`.
+
     Returns:
         dict: A read-only(!) mapping of channel names to
         :py:class:`ChannelInfo<fredirc.ChannelInfo>` objects.

fredirc/info.py

@@ -90,5 +90,3 @@ def keys(self):
 
     def values(self):
         return self._data.values()
-
-

fredirc/parsing.py

@@ -143,7 +143,7 @@ def parse_channel_mode_params(params):
         tuple of ChannelModeChange
     """
     if not params[0].startswith('+') and not params[0].startswith('-'):
-        raise ParserError(str(params))  #TODO ParserError expects the whole mesasge
+        raise ParserError(str(params))  # TODO ParserError expects the whole message
     mode_changes = []
 
     for param in params:

setup.py

@@ -25,7 +25,7 @@ def read(file):
 
 setup(
     name='FredIRC',
-    version='0.2.0',
+    version='0.3.0',
     author='Tobias Marquardt',
     author_email='[email protected]',
     description=('An easy-to-use, event driven framework for IRC bots.'),
@@ -34,7 +34,7 @@ def read(file):
     license='BSD',
     keywords='irc client library bot framework',
     url='https://worblehat.github.io/FredIRC',
-    download_url='https://github.com/worblehat/FredIRC/archive/v0.2.0.tar.gz',
+    download_url='https://github.com/worblehat/FredIRC/archive/v0.3.0.tar.gz',
     long_description=read('README.rst'),
     classifiers=[
         'Development Status :: 4 - Beta',