Download Erkle 0.0622
Download single file Erkle 0.0622
Documentation for Erkle 0.0622

Erkle is an open source IRC library for Python 3. It is being written as a replacement for Twisted in the Erk IRC Client. The current version of Erkle is 0.0622.

Erkle is not feature complete, but is functional for most purposes.

Features

• (Almost) no requirements
• Open source (MIT license)
• Small (less than 150KB, or less than 50KB for the single file version!)
• Easy to bundle with applications
• Multiple connection/client support
• SSL/TLS connection support
• Flood protection
• Event-driven
• Optional multithreading
• Extremely configurable
• DCC chat support

Requirements

• sys
• os
• socket
• collections
• string
• threading
• random
• ipaddress
• urllib.request
• ssl (optional)

Erkle uses, with one exception, only modules from the standary Python library. The ssl library is only necessary if you want to connected to an IRC server via SSL/TLS. To use the ssl module, the OpenSSL library must be installed. The easiest way to install this library is to use pip to install the pyOpenSSL library:

pip install pyopenssl

Example

from erkle import *

@irc.event("registered")
def welcome(connection):
	connection.join("#erklelib")

@irc.event("join")
def cjoin(connection,nickname,host,channel):
	if nickname == connection.nickname:
		connection.msg("Hello everyone! I'm here!")
	else:
		connection.msg(f"Hello, {nickname}! Welcome to {channel}!")

client = Erkle('erklebot','chat.freenode.net',port=7000,ssl=True)
client.connect()

Another IRC library? Why not use Twisted/irclib/...?

I wanted an IRC library with as few requirements as possible, and didn't require subclassing. I also wanted a client that was small enough to be bundled with an application, rather than requiring a user to install it through pip or some other package manager. Last, I wanted a library that wasn't focused on writing IRC bots or writing IRC clients; I wanted a library that would work for any IRC-related activity. Since I couldn't find this library, I decided to write Erkle.

Single file version

The entire library has been "compressed" into a single Python file, erklelib.py, that you can bundle with your applications. The code has not been "minimized", compressed, or otherwise changed, just compiled into a single file. Using it is just as easy as using Erkle; just change the import line to from erklelib import *.

Documentation

Erkle's documentation is available here.

The author

My name's Dan Hetrick, and I approve of this library :-)