Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

A modern Python IRC library for Python 3.4, based on asyncio. In Development.

Project description

gIRC

A modern Python IRC library for Python 3.4, based on asyncio. Currently in alpha.


PyPi Latest Version Travis-CI Build Status Coveralls Code Coverage

If you use this, anything can change without notice, everything can be overhauled, and development may even stop entirely without any warning.

If you would like to help build this, awesome! Otherwise, I’d stay away for now and use another library: irc, irc3.

Hosted Documentation

Features

This library is in development, so these features may be in various levels of completion right now.

  • Incoming and outgoing events.
  • Info and state tracking.
  • Server-based IRC mapping for dicts, lists, and strings.
  • IRCv3 capability support.
  • Escaping and unescaping IRC formatting for ease-of-use (bold, colours, etc).

Why?

I’ve been using another IRC library for a long time. It’s been pretty good, but I need more features. Handling both incoming and outgoing messages, automatic information tracking, converting IRC formatting (bold/colours/etc) to and from an escaped, human-readable and writable format.

I’ve looked at some other libraries, but they’re usually either too low-level, too involved, or too ‘magic’ for my liking. That said, this one is planning to be pretty magic, but it’s going to be magic in a way I think makes sense.

So I decided to write my own. As part of mammon-ircd, a nice low-level library called ircreactor was developed. This is also a chance to give that a spin from the client side, rather than the server side.

Running Tests

To run the test cases, go to the tests directory and run: python3 -m unittest, or use the ./runtests shell script (which also produces coverage graphs).

Acknowledgements

We bundle the ircreactor library developed as a part of mammon-ircd. This license for this library can be found in the LICENSE.ircreactor file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for girc, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size girc-0.4.0-py3-none-any.whl (39.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size girc-0.4.0.tar.gz (32.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page