python-irclib /

Filename Size Date modified Message
10 B
17.6 KB
1.7 KB
525 B
1.7 KB
9.5 KB
1.4 KB
35.6 KB
3.7 KB
irclib -- Internet Relay Chat (IRC) protocol client library
-----------------------------------------------------------

This library is intended to encapsulate the IRC protocol at a quite
low level.  It provides an event-driven IRC client framework.  It has
a fairly thorough support for the basic IRC protocol and CTCP, but DCC
connection support is not yet implemented.

In order to understand how to make an IRC client, I'm afraid you more
or less must understand the IRC specifications.  They are available
here:

    http://www.irchelp.org/irchelp/rfc/

Unfortunately, this library isn't as well-documented as I would like
it to be.  There is some documentation in HTML format in the doc
subdirectory.  It is generated from the docstrings in irclib.py by the
pythondoc utility.  I think the best way to get started is to read and
understand the example program irccat, which is included in the
distribution.

The following files might be of interest:

  * irclib.py

    The library itself.  Read the code along with comments and
    docstrings to get a grip of what it does.  Use it at your own risk
    and read the source, Luke!  There is also an HTML version of the
    docstring documentation in the doc subdirectory.

  * irccat

    A simple example of how to use irclib.py.  irccat reads text from
    stdin and writes it to a specified user or channel on an IRC
    server.

  * servermap

    Another simple example.  servermap connects to an IRC server,
    finds out what other IRC servers there are in the net and prints
    a tree-like map of their interconnections.

Enjoy.

Since I seldom use IRC anymore, I will probably not work much on the
library.  If you want to help or continue developing the library,
please contact me.

Joel Rosdahl <joel@rosdahl.net>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.